Description
Summary: Retrieves a paginated list of all webhook subscriptions via the TextPeak API.
Details: This endpoint returns a collection of webhooks configured for your account, with support for pagination and filtering. You can paginate results using the page and itemsPerPage query parameters. Additionally, you can narrow down results by filtering on webhook trigger type, HTTP method, webhook ID, name, URL, or creation date range. Authentication is performed via a TextPeak API key passed in the Authorization header.
Authentication & Scopes
Authentication is handled via a TextPeak API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the API key.
| Method | Details |
|---|---|
| API Key | Pass your TextPeak API key directly in the Authorization header value. |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Your TextPeak API key that authenticates the request. |
accept | Yes | Must be set to application/json. Indicates that the client expects a JSON response. |
Parameters
This endpoint supports the following query parameters for pagination and filtering.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | 1 | The page number for pagination. |
itemsPerPage | integer | No | 30 | The number of items returned per page. |
webhookTrigger[] | string | No | — | Filter by webhook trigger type (e.g., INCOMING_MESSAGE, MESSAGE_DELIVERY). Can be specified multiple times to filter by multiple triggers. |
method[] | string | No | — | Filter by the HTTP method configured on the webhook (e.g., GET, POST). Can be specified multiple times. |
id[] | integer | No | — | Filter by webhook ID(s). Can be specified multiple times to retrieve specific webhooks. |
name | string | No | — | Filter by webhook name. |
url | string | No | — | Filter by webhook destination URL. |
createdAt[before] | string | No | — | Filter webhooks created before this date. |
createdAt[after] | string | No | — | Filter webhooks created after this date. |
Request Body
This endpoint does not require a request body.
Examples
No saved examples are currently available for this endpoint.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||