Update webhook

Update webhook configuration including URL, events, or description.

PUT /webhooks/{webhook_id}

Update webhook

cURL

curl --request PUT \
  --url https://api.hixbe.com/sms/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Hixbe-Version: <hixbe-version>' \
  --data '
{
  "url": "<string>",
  "events": [
    "message.queued"
  ],
  "description": "<string>",
  "enabled": true
}
'

200

{
  "id": "wh_001xyz",
  "url": "https://yourapp.com/webhooks/sms",
  "events": [
    "message.delivered",
    "message.failed"
  ],
  "enabled": true,
  "secret": "whsec_abc123xyz456",
  "retry_config": {
    "max_attempts": 3,
    "backoff_seconds": 60
  },
  "last_triggered_at": "2026-01-15T10:30:00Z",
  "failure_count": 0,
  "created_at": "2025-11-01T12:00:00Z"
}

Update webhook configuration including URL, events, or description.

Authorizations

Authorization · string · header · required

Use your API key as a Bearer token. Format: Authorization: Bearer sk_live_xxxxx

Headers

Hixbe-Version · string · default: 2026-01-01 · required

API version in YYYY-MM-DD format. Using the latest version ensures access to newest features.

Pattern: ^\d{4}-\d{2}-\d{2}$

Path Parameters

webhook_id · string · required

Webhook ID

Body

application/json

url · string<uri>

Updated webhook URL

events · enum<string>[]

Updated events to subscribe to

Minimum array length: 1

Available options: message.queued, message.sent, message.delivered, message.failed, message.expired

description · string

Updated description

Maximum string length: 200

enabled · boolean

Enable or disable webhook

Response

200

application/json

Webhook updated successfully

Webhook configuration for delivery status callbacks

id · string · required

Unique webhook identifier

Example:

"wh_001xyz"

url · string<uri> · required

Callback URL (must be HTTPS)

Example:

"https://yourapp.com/webhooks/sms"

events · enum<string>[] · required

List of events to receive

Available options: message.queued, message.sent, message.delivered, message.failed, message.expired

Example:

["message.delivered", "message.failed"]

enabled · boolean · required

Whether webhook is currently active

Example:

true

secret · string

Secret key for webhook signature verification

Example:

"whsec_abc123xyz456"

retry_config · object

Retry configuration for failed deliveries

Show child attributes

last_triggered_at · string<date-time> | null

Last successful webhook delivery

Example:

"2026-01-15T10:30:00Z"

failure_count · integer

Consecutive failure count

Required range: x >= 0

Example:

0

created_at · string<date-time>

Creation timestamp

Example:

"2025-11-01T12:00:00Z"