Skip to content
Sendblue Docs
Get Started
API Reference

Webhooks

Operations for managing webhook subscriptions

Get webhooks
webhooks.list() -> WebhookListResponse
GET/api/account/webhooks
Add webhooks
webhooks.create(WebhookCreateParams**kwargs) -> WebhookCreateResponse
POST/api/account/webhooks
Replace webhooks
webhooks.update(WebhookUpdateParams**kwargs) -> WebhookUpdateResponse
PUT/api/account/webhooks
Delete webhooks
webhooks.delete(WebhookDeleteParams**kwargs) -> WebhookDeleteResponse
DELETE/api/account/webhooks
ModelsExpand Collapse
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

class WebhookListResponse: …
status: Optional[str]
webhooks: Optional[Webhooks]
call_log: Optional[List[WebhooksCallLog]]

Webhooks for call log events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

contact_created: Optional[List[str]]

Webhooks for contact created events (URL strings only)

global_secret: Optional[str]

Global secret applied to all webhooks

line_assigned: Optional[List[WebhooksLineAssigned]]

Webhooks for line assigned events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

line_blocked: Optional[List[WebhooksLineBlocked]]

Webhooks for line blocked events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

outbound: Optional[List[WebhooksOutbound]]

Webhooks for outbound message status updates

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

receive: Optional[List[WebhooksReceive]]

Webhooks for inbound message events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

typing_indicator: Optional[List[WebhooksTypingIndicator]]

Webhooks for typing indicator events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

class WebhookCreateResponse: …
message: Optional[str]
status: Optional[str]
webhooks: Optional[Webhooks]
call_log: Optional[List[WebhooksCallLog]]

Webhooks for call log events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

contact_created: Optional[List[str]]

Webhooks for contact created events (URL strings only)

global_secret: Optional[str]

Global secret applied to all webhooks

line_assigned: Optional[List[WebhooksLineAssigned]]

Webhooks for line assigned events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

line_blocked: Optional[List[WebhooksLineBlocked]]

Webhooks for line blocked events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

outbound: Optional[List[WebhooksOutbound]]

Webhooks for outbound message status updates

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

receive: Optional[List[WebhooksReceive]]

Webhooks for inbound message events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

typing_indicator: Optional[List[WebhooksTypingIndicator]]

Webhooks for typing indicator events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

class WebhookUpdateResponse: …
message: Optional[str]
status: Optional[str]
webhooks: Optional[Webhooks]
call_log: Optional[List[WebhooksCallLog]]

Webhooks for call log events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

contact_created: Optional[List[str]]

Webhooks for contact created events (URL strings only)

global_secret: Optional[str]

Global secret applied to all webhooks

line_assigned: Optional[List[WebhooksLineAssigned]]

Webhooks for line assigned events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

line_blocked: Optional[List[WebhooksLineBlocked]]

Webhooks for line blocked events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

outbound: Optional[List[WebhooksOutbound]]

Webhooks for outbound message status updates

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

receive: Optional[List[WebhooksReceive]]

Webhooks for inbound message events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

typing_indicator: Optional[List[WebhooksTypingIndicator]]

Webhooks for typing indicator events

One of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

class WebhookDeleteResponse: …
message: Optional[str]
status: Optional[str]