Get all subscription event types
You can retrieve a complete list of subscribable event types offered in the system. Use the following endpoint:
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": "Y2Y4ODYxZjMtMjI5NC00YTg4LTllM2UtZTNjZDBiNTgzNGZl",
"nextCursor": "ZDZhYTRjZTQtYWU0NC00NWY1LTk1MTEtYTc5NGIxMzIxZTk4",
"prevPageAvailable": false,
"nextPageAvailable": false,
"maxResults": 10,
"items": [
{
"category": "ITEMS",
"eventTypes": [
"ItemAvailabilityChangeEvent"
]
},
{
"category": "ACCOUNTS",
"eventTypes": [
"AccountStatus",
"AccountLowBalance"
]
}
],
"numberOfElements": 2
}
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 about 9 hours ago