v1

latestOpenAPI 3.0.02026-07-26592893.0 KB

Update SMS Webhook

Update an existing webhook configuration for the SMS service.

put/dev/webhook/v2/sms/{id}

Path parameters

idstring required

The unique Webhook ID.

Headers

Authorizationstring required

Provide "YOUR_API_KEY".

Request body

namestring required

Webhook Name - Friendly label for the webhook configuration

template'custom' | 'clevertap' required

Select Format - Webhook format to use. Choosing a format other than 'custom' (Standard Webhook) will lock the Select Event, Method, Content-Type, and Body parameters.

event'all' | 'delivered' | 'failed' required

Select Event - Filter event triggers. (Locked when format is not Standard Webhook).

identity_idstring

Entity ID - Associated Entity ID (optional). Defaults to 'all'. Only visible when Select Service is SMS.

method'POST' | 'GET' | 'PUT' required

Method - HTTP method to invoke. (Locked when format is not Standard Webhook).

urlstring required

URL - Target endpoint URL to send payloads to.

content_type'application/json' | 'application/x-www-form-urlencoded' | 'application/xml' required

Content-Type - Target encoding format for payload transmission. (Locked when format is not Standard Webhook).

payload_transform'standard' | 'raw_json' required

X-Payload-Transform - Payload transform type. Shown only when Content-Type is Form URL Encoded.

status'active' | 'inactive' required

Webhook Status - Whether the webhook trigger is active (active/inactive).

payloadstring

Body - Custom payload template structure (JSON/XML). Use dynamic placeholders like @{{request_id}}, @{{status}}, etc. (Locked when format is not Standard Webhook).

headersobject

Key-value pairs of custom headers to forward with the payload

payload_type'SIMPLIFIED' | 'RAW' required

Payload formatting level

Example request

{
  "name": "SMS Production Callback",
  "template": "custom",
  "event": "all",
  "identity_id": "109283746561",
  "method": "POST",
  "url": "https://yourdomain.com/callback",
  "content_type": "application/json",
  "payload_transform": "standard",
  "status": "active",
  "payload": "{\n  \"msg_id\": \"@{{request_id}}\",\n  \"status\": \"@{{status}}\"\n}",
  "headers": {
    "Authorization": "SecretToken123"
  },
  "payload_type": "SIMPLIFIED"
}

Response

Webhook configuration updated successfully.