Resource URL Summary
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Send an event-based notification
|
Security
| Panel | ||
|---|---|---|
| ||
In keeping with best practices, the following security mechanisms are required or recommended. Transport Layer SecurityHTTPS connection must be supported. Access ControlThe Event Notification Service will use Bearer authentication in calls to subscriber webhooks. While it's recommended that subscriber webhooks utilize the Bearer token to enforce authorized access, they can't be compelled to do so and are free to ignore it. Nevertheless, subscribers must register an access token service from which a Bearer token can be obtained. The access token service can be an OAuth Authorization Server access token service or a custom service that supports the OAuth 2.0 Client Credentials Flow |
API Specifics
Receiving an event-based notification
This REST API will send a webhook notification utilizing the POST method to the endpoint specified in the tenant configuration API.
URL
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
HTTP Headers
This API uses custom HTTP Headers:
| Header | Type | Required? | Description |
|---|---|---|---|
Authorization | string | Yes |
|
Content-Type | string | Yes | The |
HTTP Request Body
This REST API requires a body, containing the /wiki/spaces/~clee/pages/6029330 Event Notification Object.
HTTP Response
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
The webhook response should conform to CloudEvents Webhook Delivery Response.
|
Subscriber REST Services Registration
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Event notification delivery is dependent on a number of subscriber provided REST services. These service endpoints must be registered with the Event Notification Service. Subscriber REST services dependencies are as follows:
|
| Info |
|---|
Registration for this functionality will initially be done via ServicePower Professional Services. |