About the Event Notifications Service

The Event Notifications Service is a service that automates communication between the Surpass Platform and external systems (a ‘webhook’). When a pre-defined event occurs in the Surpass Platform, it triggers the ‘External Activator’ to send a request to a chosen endpoint.

For a comprehensive list of events that can be used as triggers, read the Event Notifications Service events article.

You provide the endpoint to be notified when a chosen event occurs — this is called a callback URL. When the event is triggered, the Event Notifications Service sends a POST request to your callback URL. Each request also contains a resource URI, which is a link to the specific resource in the Surpass API so you can retrieve the full details if needed.

For guidance on what to provide to the Surpass team when setting up an Event Notifications Service integration, read Setting up Event Notifications Service triggers.

NOTE: Triggered requests send minimal information to help keep requests secure. You can then securely retrieve complete details from the resource URI included in the request. For more information, read Connecting to the Surpass API v2.

Further reading

Now you know what the Event Notifications Service is, read the following articles to learn more: