Sign in
webhook

Create a webhook

post/v1/webhook/create

Request body

namestring required

Display name for the webhook.

webhookUrlstring required

Destination URL where the webhook payload will be delivered.

webhookEventstring[] required

Webhook events to subscribe to. Accepted values: email-sent, email-opened, email-link-clicked, reply-received, email-bounced, prospect-unsubscribed, prospect-finished, prospect-outcome-updated, sequence-paused, email-account-disconnected, email-account-paused, inbox-analyser-test-completed, task-created, bulk-task-updated, call-task-updated, linkedin-task-updated, custom-task-updated, whatsapp-task-updated, task-updated.

headersobject required

Custom HTTP headers included in each webhook delivery. Pass {} if no custom headers are needed.

Example request

{
  "name": "Email Sent Webhook",
  "webhookUrl": "https://example.org/webhooks/email-sent",
  "webhookEvent": [
    "email-sent"
  ],
  "headers": {
    "X-Webhook-Source": "saleshandy"
  }
}

Response

Webhook created successfully

{"stackTrail":"paths:/v1/webhook/create:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Webhook created successfully","payload":{"id":"69fb3ac1eda582171eb74826","name":"Email Sent Webhook","webhookUrl":"https://example.org/webhooks/email-sent","webhookEvent":["email-sent"],"headers":{"X-Webhook-Source":"saleshandy"},"status":"paused","testDelivery":{"status":"failed"}}}}

Example response

{
  "message": "Webhook created successfully",
  "payload": {
    "id": "69fb3ac1eda582171eb74826",
    "name": "Email Sent Webhook",
    "webhookUrl": "https://example.org/webhooks/email-sent",
    "webhookEvent": [
      "email-sent"
    ],
    "headers": {
      "X-Webhook-Source": "saleshandy"
    },
    "status": "paused",
    "testDelivery": {
      "status": "failed"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.