Webhooks

Get all webhooks

Changed on Nov 3, 2026

List all webhooks in your account.

Pagination. page (1-based, default 1) and itemsPerPage (default 30, at most 1000). The response is a plain JSON array.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

get/webhooks

Request

Base URL
https://api.commpeak.com/textpeak
URL
https://api.commpeak.com/textpeak/webhooks
Auth
API key in header Authorization

Query parameters

pageinteger nullable

Page number (1-based).

itemsPerPageinteger nullable

Items per page, at most 1000.

order[id]'asc' | 'desc'

Sort by ID.

idinteger nullable

Exact webhook ID.

namestring nullable

Webhook name contains this text.

urlstring nullable

Webhook URL contains this text.

webhookTrigger'INCOMING_MESSAGE' | 'SHORT_URL_CLICK' | 'MESSAGE_DELIVERY' | 'EDR_INFORMATION' | 'CALL_PERMISSION' nullable

Trigger (case-insensitive).

webhookTrigger[]string[] nullable

Any of these triggers.

method'GET' | 'POST' nullable

Callback HTTP method.

method[]string[] nullable

Any of these HTTP methods.

activated'true' | 'false' nullable

true for active webhooks, false for inactive ones.

createdAt[before]string nullable

Created on or before this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

createdAt[after]string nullable

Created on or after this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

Response

Successful Response

idinteger required

Unique webhook identifier.

namestring required

Webhook name.

urlstring required

HTTPS URL that receives the callback.

method'GET' | 'POST' | 'UNKNOWN' required

filterunknown required

paramsunknown required

headersunknown required

retriesinteger required

Number of retry attempts on failure.

activatedboolean required

Whether the webhook is active.

createdAtstring required

When the webhook was created. Format YYYY-MM-DD HH:MM:SS.

updatedAtstring required

When the webhook was last updated. Format YYYY-MM-DD HH:MM:SS.

Example response

[
  {
    "activated": true,
    "createdAt": "2026-03-01 09:00:00",
    "filter": {
      "stream_id": [
        5
      ]
    },
    "headers": {
      "X-Token": "your-shared-secret"
    },
    "id": 3,
    "method": "POST",
    "name": "Delivery receipts",
    "params": {
      "include_message_text": true,
      "send_bulk": false
    },
    "retries": 3,
    "updatedAt": "2026-03-02 12:30:00",
    "url": "https://demo.example.com/webhooks/delivery",
    "webhookTrigger": "MESSAGE_DELIVERY"
  }
]

Changes

Nov 3, 20265012671cf95d Revision changes
- breaking
  for the query request parameter itemsPerPage, default value 30 was added
- breaking
  the / response's property type changed from object to no type for status
- breaking
  the / response's property type changed from object to no type for status
- breaking
  the / response's property type changed from object to no type for status
- warning
  deleted the query request parameter _page
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  added the new UNKNOWN enum value to the / response property for the response status
- warning
  added the new UNKNOWN enum value to the / response property for the response status
- info
  api operation id getAllWebhooks removed and replaced with list_webhooks
- info
  the endpoint scheme security APIKeyHeader was added to the API
- info
  api tag Webhooks added
- info
  api tag Webhooks management removed
- info
  added the new optional query request parameter activated
- info
  added the new optional query request parameter createdAt[after]
- info
  added the new optional query request parameter createdAt[before]
- info
  added the new optional query request parameter id
- info
  added the new optional query request parameter method
- info
  added the new optional query request parameter method[]
- info
  added the new optional query request parameter name
- info
  added the new optional query request parameter order[id]
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter url
- info
  added the new optional query request parameter webhookTrigger
- info
  added the new optional query request parameter webhookTrigger[]
- info
  query request parameter itemsPerPage list-of-types was widened by adding types null
- info
  for the query request parameter itemsPerPage, the type was generalized from integer to no type
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status

Operation history