ApiWebhooks
Create a new webhook endpoint
POST
Creates a new webhook. The secret is only shown ONCE - save it securely! Requires webhooks:write scope when using an API key.
bearerX-API-Version?stringAPI version for header-based versioning
Default
"1"Value in
"1""2"application/json- body
url*stringWebhook endpoint URL (http/https)
events*array<string>Events to subscribe to
projectId*stringAssociated project ID
Webhook created successfully. Secret is returned only once.
curl -X POST 'http://localhost:3001/api/v1/webhooks' \ -H 'Content-Type: application/json' \ -d '{ "url": "https://api.yourapp.com/webhooks/zapapi", "events": [ "invoice.paid", "invoice.expired" ], "projectId": "uuid-of-project"}'Example Response201
Empty