Skip to main content
POST
Create a new webhook subscription

Authorizations

Authorization
string
header
required

Bearer token authentication. Include your API token in the Authorization header.

Format: Authorization: Bearer <your-token>

Body

application/json
target_url
string<uri>
required

URL where webhook events will be sent. Must be HTTPS.

subscribed_events
enum<string>[]
required

List of event types to subscribe to

Minimum array length: 1
Available options:
message.sent,
message.received,
message.read,
message.delivered,
reaction.added,
reaction.removed,
participant.added,
participant.removed,
chat.created,
chat.group_name_updated,
chat.group_icon_updated,
chat.typing_indicator.started,
chat.typing_indicator.stopped

Response

Webhook subscription created successfully. The signing_secret is only returned in this response - store it securely.

Response returned when creating a webhook subscription. Includes the signing secret which is only shown once.

id
string
required

Unique identifier for the webhook subscription

target_url
string<uri>
required

URL where webhook events will be sent

signing_secret
string
required

Secret for verifying webhook signatures. Store this securely - it cannot be retrieved again.

subscribed_events
enum<string>[]
required

List of event types this subscription receives

Available options:
message.sent,
message.received,
message.read,
message.delivered,
reaction.added,
reaction.removed,
participant.added,
participant.removed,
chat.created,
chat.group_name_updated,
chat.group_icon_updated,
chat.typing_indicator.started,
chat.typing_indicator.stopped
is_active
boolean
required

Whether this subscription is currently active

created_at
string<date-time>
required

When the subscription was created

updated_at
string<date-time>
required

When the subscription was last updated