webhooks

Send test webhook

Fire a signed sample event (payload carries test: true) at the subscription.

Omit event to use the subscription's first subscribed event.

For message.* events, pass channel (whatsapp or sms) so the sample reflects the channel you are wiring; it defaults to whatsapp.

Pass media: true with event message.received (whatsapp) to receive the media-bearing sample instead: a photo with no caption (body "" with media {type: "image", filename: null}). It exists because this is the one inbound shape you cannot otherwise rehearse over the wire without a real handset; a consumer that treats an empty body as an empty message silently drops real photos.

post/api/v1/webhooks/{id}/test

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/webhooks/{id}/test
  • Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Request body

eventstring

Example request

{
  "event": "message.delivered"
}

Response

Success

queuedboolean required
request_idstring required

Example response

{
  "delivery": {
    "id": "702e6079-28a9-48f1-a18a-7ddd140b0b85",
    "event": "message.delivered"
  },
  "queued": true,
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

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