The notification URL (web-hook) pattern is used to notify another system that a visitor record (registration) has been created or updated in Visit. The notification is only triggered on registrations where the the registration-state property is registered. Notification URLs are configured per Visit client (‘organisation’) so will apply to any active events configured within that account. When triggered, the notification URL is suffixed with the related Event ID and Visitor ID as query string parameters. A consuming application would use these properties to read (GET) the corresponding Visitor record from the API.

To configure a notification URL:

From the Organization->Setup menu, enter your URL under miscellaneous->Notifications. For example if you enter the URL:

https://notify-me.mydomain.com

Notifications will be sent in the form of an HTTP GET request to:

https://notify-me.mydomain.com?event=[event_id]&visitor=[visitor_id]

The third party application would parse the event_id and visitor_id properties from the requesting URL, then send its own GET request to the Visit API to retrieve the full detail of the Visitor record (registration).

https://api.visitcloud.com/json/visitors/[event_id]/[visitor_id]