Webhooks

Update webhook

Changed on Nov 3, 2026

Update a webhook. Only the fields you send are changed.

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

put/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.

Request body

namestring nullable

Webhook name.

urlstring nullable

Absolute HTTPS URL that receives the callback.

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

The event that fires this webhook. Case-sensitive.

method'GET' | 'POST' nullable

HTTP method used for the callback. Case-sensitive.

headersobject nullable

Custom HTTP headers sent with each callback.

retriesinteger nullable

Number of retry attempts on failure.

activatedboolean nullable

Whether the webhook is active.

Example request

{
  "retries": 5,
  "url": "https://demo.example.com/webhooks/v2/delivery"
}

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
  removed the enum value CALL_PERMISSION of the request property
- breaking
  removed the enum value EDR_INFORMATION of the request property
- breaking
  removed the enum value GET of the request property
- breaking
  removed the enum value INCOMING_MESSAGE of the request property
- breaking
  removed the enum value MESSAGE_DELIVERY of the request property
- breaking
  removed the enum value POST of the request property
- breaking
  removed the enum value SHORT_URL_CLICK of the request property
- breaking
  the request property type changed from object to no type
- breaking
  the request property type changed from object to no type
- 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 request property /
- 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 updateWebhook removed and replaced with update_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 subschema #2 to the request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  the request property became optional
- info
  the request property became optional
- info
  the request property became optional
- info
  the request property became optional
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- 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
  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