webhooks

Create a webhook subscription

textbee POSTs the events you pick to your delivery URL and signs each request with your signing secret, sent as the X-Signature header. Failed deliveries are retried up to 10 times, and a subscription that keeps failing is paused.

post/api/v1/webhooks

Request

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

Request body

namestring

Label shown in the dashboard. Up to 64 characters.

deliveryUrlstring required

URL textbee POSTs events to. Must be http or https and publicly reachable. Private and loopback hosts are rejected.

signingSecretstring required

Shared secret, at least 20 characters. textbee signs every delivery with it and sends the signature in the X-Signature header, so your endpoint can verify the request really came from textbee.

eventsstring[] required

Events to deliver. At least one is required.

Example request

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

Response

The subscription was created.

Changes

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