Delete specific webhooks

client.webhooks.delete(, ?): WebhookDeleteResponse { status, message }

delete/api/v2/account/webhooks

Delete specific webhooks from your account.

ParametersExpand Collapse

body: WebhookDeleteParams { webhooks, type }

webhooks: Array<string>

Array of webhook URLs to delete

type?: "receive" | "call_log" | "line_blocked" | 3 more

Webhook type (default to 'receive')

Accepts one of the following:

"receive"

"call_log"

"line_blocked"

"line_assigned"

"outbound"

"contact_created"

ReturnsExpand Collapse

WebhookDeleteResponse { status, message }

status: "OK" | "ERROR"

Accepts one of the following:

"OK"

"ERROR"

message?: string

Delete specific webhooks

import SendblueAPI from 'sendblue';

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

const webhook = await client.webhooks.delete({ webhooks: ['https://example.com'] });

console.log(webhook.status);

{
  "status": "OK",
  "message": "message"
}

Returns Examples

{
  "status": "OK",
  "message": "message"
}