Scheduler Zero
REST APIAPI referenceWebhooks

Subscribe to events (create a webhook)

Registers a target URL to receive a `WebhookPayload` POST when a matching event fires — the subscribe step for a Zapier/Make instant trigger. Persist the returned `id` to unsubscribe later. Requires the `webhook:create` permission.

POST
/settings/webhooks

Registers a target URL to receive a WebhookPayload POST when a matching event fires — the subscribe step for a Zapier/Make instant trigger. Persist the returned id to unsubscribe later. Requires the webhook:create permission.

Authorization

ApiKeyAuth
x-api-key<token>

API key created under Settings → API Keys. Scoped to a single workspace.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/settings/webhooks" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "http://example.com",    "eventTypes": [      "first_email_reply"    ]  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "name": "string",  "url": "http://example.com",  "secret": "string",  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",  "campaignName": "string",  "eventTypes": [    "first_email_reply"  ],  "isSlackWebhook": true,  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}