Post Webhook
webhook
{IntegratorProvidedURL}
STS Gen2 includes resource level notifications that it facilitates via webhooks.
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. Timeout for HTTP requests to subscribers is 15 seconds with no retry
HTTP POST requests from the STS Gen2 Notifications Service include Digest and Key-Id headers to allow the message to be verified.
Example notification message
The following example shows the contents of the notification message body in JSON format:
{
"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.
Request
- application/json
-
Digest(required): string
Digest HMACSHA256 using key provided by Integrator at time of registration/subscription. The value of digest is Base64 encoded HMACSHA256 hash of the ASCII-encoded request message body. The Base64 decoded subscriber's Key is used as the hash key.
-
Key-Id(required): string
Key ID that was used to sign the digest.
Response
- application/json