Handling Events

Webhook Configuration

To begin handling events you will need to configure your webhook URL and what events that you would like to recieve. This can be done on the partner portal within the Events integration configuration.

The webhook URL configured must accept JSON request payloads and support HMAC verfication. You will be able to test this on the portal when configuring your webhook.

How to implement HMAC verification

Responding to Events

To successfully acknowledge reciept of an event, you will need to return with a 2xx status code. If we recieve any non-2xx status code we will proceed to retry the request according to a exponential backoff policy.

If you begin to exceed high failure rates (10-25%) an alert will be sent to the partner email on file. A circuit breaker is in place at 50%, when tripped will result in all events being turned off for a period of time along with another alert being sent to the partner email.

Sending Events to Stream

You can send events to stream via the Handle Webhook Event (Stream -> POS) endpoint.

Requests must be sent as a POST request with a JSON payload, and include a HMAC signature header.