Get all subscription event types
Use GET {URI}/webhooks/eventtypes
to retrieve information about a specific event type or list of supported event types:
Endpoint | Purpose |
---|---|
GET {URI}/webhooks/eventtypes | To get the event types of all your webhook subscriptions. |
The following query parameters are used to paginate the results. Use these query parameters with GET {URI}/webhooks/eventtypes
webhook to list the type of events available in your subscriptions:
Query params | Data type | Requirement | Description |
---|---|---|---|
prevCursor | string | optional | The cursor to use for the previous page of results. This will be ignored if paginate is false. |
nextCursor | string | optional | The cursor to use for the next page of results. This will be ignored if paginate is false. |
maxResults | int32 defaults to 10 | optional | The maximum number of results to return. It must be an integer up to 200. The default is 10. maxResults will be ignored if paginate is false. |
category | string | optional | Specify the category to return |
Here's the response example for when you use GET {URI}/webhooks/eventtypes
:
{
"prevCursor": "T1JERVI=",
"nextCursor": "UkVXQVJE",
"prevPageAvailable": true,
"nextPageAvailable": false,
"maxResults": 10,
"items": [
{
"category": "ORDER",
"eventTypes": [
"LineItemDeliveryStatus"
]
},
{
"category": "ITEM",
"eventTypes": [
"ItemAvailability"
]
},
{
"category": "ACCOUNT",
"eventTypes": [
"Transaction",
"LowBalance",
"AccountStatus"
]
},
{
"category": "REWARD",
"eventTypes": [
"RewardStatus"
]
}
],
"numberOfElements": 4
}
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
- 403 Forbidden
- 404 Not Found
Updated 7 days ago