Get subscription events
Are you interested in seeing all of your past subscription events in one place? Perhaps you need to review and clean up the old notifications. Use GET {URI}/webhooks/{webhookId}/events
to retrieve a list of events that have been sent to a specific webhook.
Use the following endpoint to get past subscription events:
Endpoint | Purpose |
---|---|
GET {URI}/webhooks/{webhookId}/events | To get subscription events |
The following path parameter is used with GET /webhooks/{webhookId}/events
:
Parameter | Data type | Description |
---|---|---|
webhookId | string | The specific event ID |
The following query parameters are used with GET /webhooks/{webhookId}/events
:
Parameter | Data type | Description |
---|---|---|
fromRevision | int64 | (Optional) The beginning revision number to be replayed. It must be an integer up to 64 digits. |
toRevision | int64 | (Optional) The ending revision number. It must be an integer up to 64 digits. |
prevCursor | string | (Optional) Specify previous cursor to return. |
nextCursor | string | (Optional) Specify next cursor to return. |
maxResults | int32 | (Optional) Specify the maximum results to return. It must be an integer up to 32 digits |
The following sample response is returned when you use GET {URI}/webhooks/{webhookId}/events
to get subscription events:
{
"numberOfElements": 0,
"maxResults": 0,
"nextPageAvailable": true,
"nextCursor": "string",
"prevCursor": "string",
"prevPageAvailable": true,
"items": [
{
"eventId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"revision": 0,
"eventType": "string",
"categories": [
"string"
],
"eventOccurredAt": "2024-06-13T20:06:24.565Z",
"eventData": {
"accountIdentifier": "string",
"status": "string"
}
}
]
}
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
Updated 7 days ago