Create an event subscription

To add event notifications to your integration, use our API to create an event subscription and handle the notification that we send by webhook when an event occurs.

To create an event subscription, send the following information in your request:

• Event type - The event that you want to subscribe to. You can subscribe to more than one event within the same request.
• URI - The endpoint that we send notifications to. The endpoint must be publicly available.
• Secret - A secret that we return in the header of webhook requests to verify that it is a genuine request.
• Event status - The status of the event subscription.
• Email address - An email address that we contact if we can’t communicate with the endpoint that you provided.

Integration steps

Step 1. Create an event subscription
Step 2. Send a 200 response code
Step 3. Handle the notification content

Before you begin

Bearer tokens

Use our Identity Service to generate a Bearer token to include in the header of your requests. To generate your Bearer token, complete the following steps:

1. Include your API key in the x-api-key parameter in the header of a POST request.
2. Send your request to https://identity.payroc.com/authorize.

Example request

$
curl --location --request POST 'https://identity.payroc.com/authorize' --header 'x-api-key: <api key>'

Example response

If your request is successful, we return a response that contains your Bearer token, information about its scope, and when it expires.

1
{
2
  "access_token": "eyJhbGc....adQssw5c",
3
  "expires_in": 3600,
4
  "scope": "service_a service_b",
5
  "token_type": "Bearer"
6
}

Headers

To create the header of each POST request, you must include the following parameters:

• Content-Type: Include application/json as the value for this parameter.
• Authorization: Include your Bearer token in this parameter.
• Idempotency-Key: Include a UUID v4 to make the request idempotent.

$
curl
>
  -H "Content-Type: application/json"
>
  -H "Authorization: <Bearer token>"
>
  -H "Idempotency-Key: <UUID v4>"

Errors

If your request is unsuccessful, we return an error. For more information about errors, see Errors.

Step 1. Create an event subscription

To create an event subscription, send a POST request to our event subscriptions endpoint.

Request parameters

To create the body of your request, use the following parameters:

Example request

1
curl -X POST https://api.payroc.com/v1/event-subscriptions \
2
     -H "Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324" \
3
     -H "Authorization: Bearer <token>" \
4
     -H "Content-Type: application/json" \
5
     -d '{
6
  "enabled": true,
7
  "eventTypes": [
8
    "foo"
9
  ],
10
  "notifications": [
11
    {
12
      "type": "webhook",
13
      "uri": "https://my-server/notification/endpoint",
14
      "secret": "aBcD1234eFgH5678iJkL9012mNoP3456",
15
      "supportEmailAddress": "foo"
16
    }
17
  ]
18
}'

Response fields

If your request is successful, we send you the ID of the subscription. You can use the ID to update, retrieve, or delete the event subscription.

The response contains the following fields:

Example response

1
{
2
  "enabled": true,
3
  "eventTypes": [
4
    "processingAccount.status.changed"
5
  ],
6
  "notifications": [
7
    {
8
      "type": "webhook",
9
      "uri": "https://my-service/notification/endpoint",
10
      "secret": "**********NoP3456",
11
      "supportEmailAddress": "[email protected]"
12
    }
13
  ],
14
  "id": 2565435189324,
15
  "status": "registered",
16
  "metadata": {
17
    "yourCustomField": "abc123"
18
  }
19
}

Step 2. Send a 200 response code

We send notifications by webhook request to the URI endpoint that you provided when you created the subscription.

You must return a 200 status code when you receive the request.

If we do not receive a 200 response, we retry the request five times. After the fifth attempt, we send an email to the support email address that you provided when you created the subscription.

Step 3. Handle the notification content

Each notification follows the CloudEvents standard, and we use the data object to communicate information about the event that occurred, for example:

1
{
2
  "specversion": "1.0",
3
  "type": "processingAccount.status.changed",
4
  "version": "1.0",
5
  "source": "payroc",
6
  "id": "123e4567-e89b-12d3-a456-426614174000",
7
  "time": "2024-07-02T15:30:00.000Z",
8
  "datacontenttype": "application/json",
9
  "data": {
10
    "processingAccountId": "38765",
11
    "status": "entered"
12
  }
13
}

You can view our event notifications on the Events page.