webhooks

Update a webhook subscription

Changes only the fields you send. Use isActive to re-enable a subscription textbee paused after repeated failures.

patch/api/v1/webhooks/{webhookId}

Request

  • Base URL: https://api.textbee.dev
  • URL: https://api.textbee.dev/api/v1/webhooks/{webhookId}
  • Auth: API key in header x-api-key

Path parameters

webhookIdstring required

Subscription id, from GET /webhooks.

Request body

namestring

Label shown in the dashboard. Up to 64 characters.

isActiveboolean

Whether deliveries are attempted. Set it to true to re-enable a subscription textbee paused after repeated failures.

deliveryUrlstring

New delivery URL. Same rules as on create: http or https, no private or loopback hosts.

signingSecretstring

New signing secret, at least 20 characters.

eventsstring[]

Replacement event list. Cannot be empty.

Example request

{
  "name": "Order notifications",
  "deliveryUrl": "https://example.com/textbee/webhook",
  "events": [
    "MESSAGE_RECEIVED",
    "MESSAGE_DELIVERED"
  ]
}

Response

The updated subscription.

Changes

No recorded changes to this operation across all 1 revision of this API.