SchemaNotificationsEvent Subscriptions

Create event subscription

Use this method to create an event subscription that we use to notify you when an event occurs, for example, when we change the status of a processing account. In the request, include the events that you want to subscribe to and the public endpoint that we send event notifications to. For a complete list of events that you can subscribe to, go to [Events List](https://docs.payroc.com/knowledge/events/events-list). In the response, our gateway returns the id of the event subscription, which you can use to perform follow-on actions.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).

Request

This endpoint expects an object.
enabledbooleanRequired
Indicates if we should notify you when the event occurs. The value is one of the following: - `true` - We notify you when the event occurs. - `false` - We don't notify you when the event occurs.
eventTypeslist of stringsRequired

Array of events that you want to subscribe to. For a list of events, go to Events List.

notificationslist of objectsRequired
Array of notifications objects. Each object contains information about how we contact you when an event occurs.
metadataobjectOptional

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Response

Successful request. We created the event subscription.
enabledboolean
Indicates if we should notify you when the event occurs. The value is one of the following: - `true` - We notify you when the event occurs. - `false` - We don't notify you when the event occurs.
eventTypeslist of strings

Array of events that you want to subscribe to. For a list of events, go to Events List.

notificationslist of objects
Array of notifications objects. Each object contains information about how we contact you when an event occurs.
idlong or null
Unique identifier that we assigned to the event subscription.
statusenum or null
Status of the subscription. We return one of the following values: - `registered` - You have set up the subscription, and we will notify you when an event occurs. - `suspended` - We have deactivated the event subscription, and we won't notify you when an event occurs. - `failed` - We couldn't contact your URI endpoint. We email the supportEmailAddress.
Allowed values:
metadataobject or null

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Errors