Skip to main content
POST
/
webhooks
Create a new webhook
curl --request POST \
  --url http://localhost/public/v1/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [],
  "is_enabled": true
}
'
{
  "ok": true,
  "webhook": {
    "id": "<string>",
    "url": "<string>",
    "events": "<string>",
    "is_enabled": "<string>",
    "secret": "<string>",
    "source": "<string>",
    "locked": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Body

application/json
​
url
string<uri>
required

Required. The URL where webhook events will be sent.

Maximum string length: 2048
​
events
enum<string>[]
required

Required. Array of event names to subscribe to.

Minimum array length: 1

Required. Event name must be one of the valid webhook events.

Available options:
email.queued,
email.sent,
email.bounced.soft,
email.bounced.hard,
email.deferred,
email.opened,
email.clicked,
email.bot.opened,
email.bot.clicked,
email.replied,
email.contact.saved,
email.contact.unsubscribed,
email.lead.created,
email.sale.created
​
is_enabled
boolean

Optional. Whether the webhook is enabled (default: true).

​
source
enum<string> | null

Optional. Indicates integration-managed webhooks. Allowed values: n8n, zapier, make, internal.

Available options:
n8n,
zapier,
make,
internal

Response

​
ok
boolean
required
​
webhook
TeamWebhookResource · object
required