API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get webhooks

GET/api/account/webhooks

Get all webhooks configured for the authenticated account

ReturnsExpand Collapse

status: optional string

webhooks: optional object { call_log, contact_created, globalSecret, 5 more }

call_log: optional array of string or WebhookConfiguration { url, secret }

Webhooks for call log events

One of the following:

UnionMember0 = string

WebhookConfiguration = object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

contact_created: optional array of string

Webhooks for contact created events (URL strings only)

globalSecret: optional string

Global secret applied to all webhooks

line_assigned: optional array of string or WebhookConfiguration { url, secret }

Webhooks for line assigned events

One of the following:

UnionMember0 = string

WebhookConfiguration = object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

line_blocked: optional array of string or WebhookConfiguration { url, secret }

Webhooks for line blocked events

One of the following:

UnionMember0 = string

WebhookConfiguration = object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

outbound: optional array of string or WebhookConfiguration { url, secret }

Webhooks for outbound message status updates

One of the following:

UnionMember0 = string

WebhookConfiguration = object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

receive: optional array of string or WebhookConfiguration { url, secret }

Webhooks for inbound message events

One of the following:

UnionMember0 = string

WebhookConfiguration = object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

typing_indicator: optional array of string or WebhookConfiguration { url, secret }

Webhooks for typing indicator events

One of the following:

UnionMember0 = string

WebhookConfiguration = object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

Get webhooks

HTTP

HTTP

TypeScript

Python

curl https://api.sendblue.co/api/account/webhooks \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"

200 example

{
  "status": "OK",
  "webhooks": {
    "call_log": [
      "https://example.com"
    ],
    "contact_created": [
      "https://example.com"
    ],
    "globalSecret": "whsec_global123",
    "line_assigned": [
      "https://example.com"
    ],
    "line_blocked": [
      "https://example.com"
    ],
    "outbound": [
      "https://example.com"
    ],
    "receive": [
      "https://example.com"
    ],
    "typing_indicator": [
      "https://example.com"
    ]
  }
}

Returns Examples

200 example

{
  "status": "OK",
  "webhooks": {
    "call_log": [
      "https://example.com"
    ],
    "contact_created": [
      "https://example.com"
    ],
    "globalSecret": "whsec_global123",
    "line_assigned": [
      "https://example.com"
    ],
    "line_blocked": [
      "https://example.com"
    ],
    "outbound": [
      "https://example.com"
    ],
    "receive": [
      "https://example.com"
    ],
    "typing_indicator": [
      "https://example.com"
    ]
  }
}