Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

5.15.0

The Event Notification REST API provides an on-demand, push-based mechanism for being notified of various events, as a result for changes in integrated sub-systems.

The Event Notification API can be enabled via setup utilizing the Tenant Configuration APIs.       



On this page:

Related pages:

Resource URL Summary

Send an event-based notification

POST <Subscriber_Webhook_Secure_URL>

Security

In keeping with best practices, the following security mechanisms are required or recommended.

Transport Layer Security

HTTPS connection must be supported.

Access Control

The 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

POST <Subscriber_Webhook_Secure_URL>


HTTP Headers

This API uses custom HTTP Headers:

HeaderTypeRequired?Description
AuthorizationstringYes

Authorization: Bearer <BEARER_TOKEN>

    • <BEARER_TOKEN> is a Bearer token obtained from the subscriber access token service
Content-TypestringYes

The Content-Type HTTP Header may be set application/json 

HTTP Request Body

This REST API requires a body, containing the /wiki/spaces/~clee/pages/6029330.

HTTP Response

The webhook response should conform to CloudEvents Webhook Delivery Response.

Response payloads from successful notification deliveries will be ignored.

Subscriber REST Services Registration

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:

  • Event Notification Subscriber Webhook
  • OAuth Authorization Server or a custom access token service that supports the OAuth 2.0 Client Credentials Flow
    • Client Id and Client Secret must be created for the Event Notification Service and registered.

Registration for this functionality will initially be done via ServicePower Professional Services.

  • No labels