Top.Mail.Ru

Advanced UnSpot Plan from $100 $50 for Your Company Fix this Price

Promo deadline:
Help center / Administration / Integrations / API and Webhooks / Incoming Webhooks setting up guide

Incoming Webhooks setting up guide

Event Subscription allows UnSpot to receive real-time event notifications from other systems using Access Control (PACS). This tool provides integration between UnSpot and PACS via HTTPS requests and is suitable for a variety of systems that work with the JSON format.

See also: Incoming webhooks API reference — full reference: subscription setup, field mapping, office to access point mapping and error handling.

When an event occurs in PACS (for example, a user passes through an access control system), information about it is sent to UnSpot, where the following information is updated:
– The “In Office” status is displayed in the user’s card and on the map.
– Booking is automatically confirmed in the second step of the checkin if the appropriate policies are enabled for desk.
– The information appears in the “History of Office Visits (PACS)” report, which is available only to the administrator.

To configure the subscription, you need to create a URL to which the PACS will send the event data. To do this, perform the following steps:

  1. Go to Manage → Integrations → Incoming webhooks
  2. Click the “Create incoming webhook” button.
  3. Under “Data transfer method”, select “JSON”.
  4. In the “Data Formatting Settings” block, enter the JSON keys in which your PACS sends the data. All four fields are required; the form fills in office, location, email and status by default:
    Office — the key holding the access point (turnstile, door) the employee passed; UnSpot uses it to determine the office of the visit.
    Location — the key holding a location name; it has to be present in every event, otherwise the event is rejected.
    User — the key holding the employee identifier: email, pass number, full name or display name.
    Status — the key holding the direction: in_office or out_office.
  5. If needed, fill in the “Office PACS access point mapping” block: click “Add office”, pick an office or a space inside it (such as a floor), then under “Access points” click “Add” and enter the value your PACS sends in the Office key — for example, a turnstile name. This tells UnSpot which office the employee entered and puts it into the History of Office Visits (PACS) report. Without the block the subscription works, but no office is recorded. The rules for access points are in the Incoming webhooks API reference.
  6. If needed, click “Add token”: UnSpot creates a secret token that has to be sent in the Un-Token header of every request. The token can be copied only while the subscription is being created and cannot be regenerated later — if it is lost, delete the subscription and create a new one.
  7. Click the “Add” button.

After adding the subscription, the URL link will be automatically generated on the page, and you can use it to transfer data from other systems.

  1. You can copy the generated link for further use in other systems integrated with PACS. A token is automatically created in the link to ensure secure connection.
  2. If necessary, you can activate or deactivate the subscription.
  3. If the attributes change, you have the option to edit the subscription or delete it.

Leave a request for a call and we will contact you

Loading