Event Notification Service Activities
For the Event Notification Service to establish an active subscription that receives and processes notification events involves a sequence of activities. You are responsible for creating a callback (setup), for providing a callback URL endpoint (callbackURL), and for processing posted notifications (customerSystem).
The diagram shows the sequence of events and the required components.
- To register your callback URL, your system calls the Create Callback API.
- The ENS syntactically validates your callback URL and issues an HTTPS POST to that URL. The response body contains a unique callback ID and verification key.
- To complete callback creation, your callback captures the callback ID and verification key and returns an HTTP 200 status.
- Your system verifies the callback. Ensure that your callback completes verification within four hours.
- The ENS compares the verification key supplied and confirms that it is the same as the verification key provided during callback validation. Your callback prepares to receive event notification payloads for the events you subscribe to.
- Your setup uses the Create Subscription API to register interest in event notifications and provides the callback ID returned during callback validation.
- The ENS sends batches of event notifications to your callback via an HTTPS POST up to the maximum batch size you indicated when you created the callback.
- Your callback receives a batch of notification events and has a maximum of three seconds to process them and return an HTTP 200, 201, 202, 203, or 204, indicating successful processing.