API Reference

Webhooks

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Get all webhooks

client.webhooks.list(RequestOptionsoptions?): WebhookListResponse { status, message, webhooks }

get/api/v2/account/webhooks

Get all webhooks configured for your account.

ReturnsExpand Collapse

WebhookListResponse { status, message, webhooks }

status: "OK" | "ERROR"

Accepts one of the following:

"OK"

"ERROR"

message?: string

webhooks?: WebhookConfiguration { call_log, contact_created, globalSecret, 5 more }

call_log?: Array<string | WebhookObject { url, secret } >

Webhooks for call logs

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

contact_created?: Array<string>

Webhooks for contact creation (URL strings only)

globalSecret?: string

Global secret applied to all webhooks

line_assigned?: Array<string | WebhookObject { url, secret } >

Webhooks for line assignment

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

line_blocked?: Array<string | WebhookObject { url, secret } >

Webhooks for blocked lines

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

outbound?: Array<string | WebhookObject { url, secret } >

Webhooks for outbound messages

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

receive?: Array<string | WebhookObject { url, secret } >

Webhooks for inbound messages

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

secret?: string

Legacy secret field

Get all webhooks

TypeScript

• HTTP
• TypeScript
• Python

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const webhooks = await client.webhooks.list();

console.log(webhooks.status);

200 example

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

Returns Examples

200 example

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