We trigger an event when we make a change to a resource or complete a process, for example, when we change the status of a processing account. When you subscribe to an event, each time we trigger it we send you a notification to inform you about the change. We send the notification by a webhook request to an endpoint that you specify when you subscribe to the event. For more information about how to subscribe to events, go to Create an events subscription.

Note: If we don't receive a 200 response to the webhook request, we retry the request up to five times. If the request is still unsuccessful after five retry attempts, we contact the support email address that you specified when you subscribed to the event.

CloudEvents attributes

We use the CloudEvents standard to format our event notifications. Each notification has the following attributes:

Attribute	Description
specversion	Version of the CloudEvents specification that the event notification follows.
type	Type of event that occurred.
version	Version of the event type in our specification.
source	Indicates the origin of the event.
id	Unique identifier of the event.
time	Time stamp of the event.
datacontenttype	Indicates the format of the data object.
data	Information about the change that triggered the event.

Example

{
  "specversion": "1.0",
  "type": "processingAccount.status.changed",
  "version": "1.0"
  "source": "payroc",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "time": "2024-05-12T12:34:56.789Z",
  "datacontenttype": "application/json",
  "data": {
    "processingAccountId": "12345678",
    "status": "entered"
  }
}

Events

You can subscribe to the following events with our API:

Type	Change	Resource	Version
processingAccount.status.changed	We have changed the status of a processing account.	Boarding	1.0

Events list

CloudEvents attributes

Example

Events