The STS Gen2 Notifications Service is used to manage call back POST notifications messages that are sent to the integrator when they register to receive organization, configuration, check, and employee events.

Integrators must expose a service endpoint which accepts HTTP POST requests (webhook) to receive notifications from the STS Gen2 Notifications Service. The endpoint must implement TLS 1.2 and listen on port 443.The following top-level domains .com, .net, .org, .edu, .ca, .io, .site, .se, .sa are supported.

Paths

Resource	Base path
Notifications API	https://host/api/v1/

Supported notifications

Integration type	Notifications
STS Gen2 cloud integrations	Organizations Notification Configuration Notification Check Notification Employees Notification
STS Gen2 on-premises integrations	Check Notification

Example notification message

{
        "messages": [
            {
                "id": "8253c2a5-5b3c-497d-a87f-f8bb2e250ba7",
                "creationDate": "2021-08-13T15:40:43.511Z",
                "messageType": {
                    "id": "CheckNotification"
                },
                "resource": {
                    "orgShortName": "tfoinc",
                    "locRef": "fdmnh144",
                    "rvcRef": "42",
                    "checkRef": "929aacee2c6d42c78ae877e824c28eed00000431"
                },
                "data": {
                    "status": "Submitted",
                    "timeStampUtc": "2021-08-13T15:40:44.501Z"
                }
            }
        ]
    }
 

Retry logic

At present retries are not supported. A notification will be sent only once.