Webhooks

Get webhook

Changed on Nov 3, 2026

Retrieve a single webhook by its ID.

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

get/webhooks/{id}

Request

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

Path parameters

idinteger required

Unique identifier of the resource.

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
  added the new path request parameter id
- 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
  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 getWebhook removed and replaced with get_webhook
- 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 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
  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