Events

Events let publishers know when something interesting happens in their account. When an interesting event occurs, creates a new Event object.

Below are a few examples of when a new event object is created:

Events occur when the state of another API resource changes. The event’s data field embeds the resource’s state at the time of the change. For example, a transaction.created event contains a transaction.

This section describes the payload format for a typical webhook event object. All fields below are required. The data field contains the actual payload, while the other fields provide supplementary information that identify and route the webhook appropriately.

Event Object

publisher_uid string

required

Unique identifier for the Publisher

publisher_user_id string

required

Unique identifier for the user. This is the ID sent by the publisher, to uniquely identify a user in the publisher’s system.

event_type string

required

Represents the type of event this webhook was invoked. For example, TRANSACTION.

data dictionary

required

Object containing the API resource relevant to the event. For example, a transaction.created event has the Transactions object as the value of the object key.

event_timestamp string

required

The event timestamp generated to prevent replay attacks. Format is yyyy-MM-dd'T'HH:mm:ss

Below is an example of the webhook request payload: