Sign in
Webhooks

Create Webhook

Create a new webhook for your Team

post/api/webhooks

Request body

endpoint_urlstring required

The URL of your webhook endpoint.

signing_secretstring nullable

Optionally, add a signing secret to protect your webhook.

eventsstring[] required

An array of webhook events to subscribe to. Options: messages.received, messages.sent, messages.ppv.unlocked, subscriptions.new, users.typing, posts.liked, accounts.connected, accounts.reconnected, accounts.session_expired, accounts.authentication_failed, accounts.otp_code_required, accounts.face_otp_required

Example request

{
  "endpoint_url": "https://example.com",
  "events": [
    "accounts.connected",
    "subscriptions.new"
  ]
}

Response

idstring
urlstring
has_signing_secretboolean
eventsstring[]
created_atstring

Example response

{
  "id": "wh_abc123",
  "url": "https://example.com",
  "has_signing_secret": true,
  "events": [
    "accounts.connected",
    "subscriptions.new"
  ],
  "created_at": "2025-01-01T00:00:00.000000Z"
}

Changes