Get all subscriptions
If you'd like to obtain information about all the webhooks you've subscribed to on the platform without specifying a particular webhook ID, you can easily achieve it by making a GET request to the {URI}/webhooks
endpoint. This straightforward approach provides you with a comprehensive overview of all your registered webhooks.
Endpoint | Purpose |
---|---|
GET {URI}/webhooks | To get all subscriptions |
The following table shows the query parameters for when you use GET {URI}/webhooks
to get the information for all your webhook subscriptions:
Parameter | Data type | Description |
---|---|---|
prevCursor | string | The cursor to use for the previous page of results. This will be ignored if paginate is false. |
nextCursor | string | The cursor to use for the next page of results. This will be ignored if paginate is false. |
maxResults | int32 defaults to 10 | 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. |
url | string | The URI that user shares with Tango. Tango uses this URI to POST the webhook back to the user. |
headerName | string | Contains any header name submitted by the customer. |
headerValue | string | Contains any header value submitted by the customer. |
categories | array of strings | Designated subscribed to categories. |
eventTypes | array of strings | Designated subscribed to events. |
expiresAtFrom | date-time | Specify the starting expiration date or date time to be queried according to RFC 3339, i.e. "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt |
expiresAtTo | date-time | Specify the ending expiration date or date time to be queried according to RFC 3339, i.e. "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt |
createdAtFrom | date-time | Specify the starting created date or date time to be queried according to RFC 3339, i.e. "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt |
createdAtTo | date-time | Specify the ending created date or date time to be queried according to RFC 3339, i.e. "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt |
The following response shows how you can get all subscription by using GET {URI}/webhooks
:
{
"numberOfElements": 0,
"maxResults": 0,
"nextPageAvailable": true,
"nextCursor": "string",
"prevCursor": "string",
"prevPageAvailable": true,
"items": [
{
"webhookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"categories": [
"string"
],
"eventTypes": [
"string"
],
"signingCertificate": "string",
"createdAt": "2024-06-13T19:01:16.536Z",
"updatedAt": "2024-06-13T19:01:16.536Z",
"expiresAt": "2024-06-13T19:01:16.536Z"
}
]
}
The following response messages are available for this endpoint:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
Updated 2 months ago