Skip to content
Sendblue Docs
Get Started
API Reference
Webhooks

Replace webhooks

webhooks.update(WebhookUpdateParams**kwargs) -> WebhookUpdateResponse
put/api/account/webhooks

Replace all webhooks for the account. This overwrites existing webhooks.

ParametersExpand Collapse
webhooks: Webhooks
global_secret: Optional[str]

Global secret applied to all webhooks

line_assigned: Optional[SequenceNotStr[WebhooksLineAssigned]]

Webhooks for line assigned events

Accepts 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[SequenceNotStr[WebhooksLineBlocked]]

Webhooks for line blocked events

Accepts 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[SequenceNotStr[WebhooksOutbound]]

Webhooks for outbound message events

Accepts 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[SequenceNotStr[WebhooksReceive]]

Webhooks for inbound message events

Accepts one of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

ReturnsExpand Collapse
class WebhookUpdateResponse: …
message: Optional[str]
status: Optional[str]
webhooks: Optional[Webhooks]
global_secret: Optional[str]

Global secret applied to all webhooks

line_assigned: Optional[List[WebhooksLineAssigned]]

Webhooks for line assigned events

Accepts 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

Accepts 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 events

Accepts 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

Accepts one of the following:
str
class WebhookConfiguration: …
url: str

Webhook endpoint URL for receiving callbacks

formaturi
secret: Optional[str]

Secret for webhook signature verification

Replace webhooks
import os
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key=os.environ.get("SENDBLUE_API_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SENDBLUE_API_API_SECRET"),  # This is the default and can be omitted
)
webhook = client.webhooks.update(
    webhooks={},
)
print(webhook.message)
{
  "message": "Webhooks updated successfully",
  "status": "OK",
  "webhooks": {
    "globalSecret": "whsec_global123",
    "line_assigned": [
      "https://example.com"
    ],
    "line_blocked": [
      "https://example.com"
    ],
    "outbound": [
      "https://example.com"
    ],
    "receive": [
      "https://example.com"
    ]
  }
}
Returns Examples
{
  "message": "Webhooks updated successfully",
  "status": "OK",
  "webhooks": {
    "globalSecret": "whsec_global123",
    "line_assigned": [
      "https://example.com"
    ],
    "line_blocked": [
      "https://example.com"
    ],
    "outbound": [
      "https://example.com"
    ],
    "receive": [
      "https://example.com"
    ]
  }
}