Webhooks: Get Notified for a Change

SCS has a mechanism to notify third-party systems when an important event or trigger occurs in the application. To receive notification, a URL must be provided which accepts an HTTP GET request. SCS includes additional trigger fields as parameters which are appended to the URL.

A set of webhooks sends an HTTP POST request. With a POST, data elements are sent by way of the posted data as opposed to being sent as request parameters on the URL. The body of the posted data will be a JSON document, so the receiver should be set to accept a content type of application/json. All webhooks use GET requests except where otherwise noted in the documentation.

The POST JSON document consists of three elements, security, common and data. The security and common elements contain the data documented in the following section. Data specific to the webhook action is available in the data element in the following section.

For example: