Simphony Transaction Services Gen2 API Guide

Subcategories:
Webhook

Notifications API REST Endpoints

Notifications API

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.

The following notifications are supported for STS Gen2 cloud integrations:
- Organizations Notification
- Configuration Notification
- Check Notification
- Employees Notification

The following notifications are supported for 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.

Paths

The {basePath} for resources on the Notifications API is:

https://{host}/api/v1/

Delete a subscriber: Method: delete
Path: {basePath}/notifications/registration
Delete subscriptions: Method: delete
Path: {basePath}/notifications/subscriptions
Delete the subscription by a subscriptionId: Method: delete
Path: {basePath}/notifications/subscriptions/{subscriptionId}
Get message types: Method: get
Path: {basePath}/notifications/discovery
Get subscriptions: Method: get
Path: {basePath}/notifications/subscriptions
Get the subscription by a subscriptionId: Method: get
Path: {basePath}/notifications/subscriptions/{subscriptionId}
Post create a subscription: Method: post
Path: {basePath}/notifications/subscriptions
Post creates an integrator registration: Method: post
Path: {basePath}/notifications/registration
PUT creates or updates integrators registration: Method: put
Path: {basePath}/notifications/registration