Plot HomeDocumentation
Webhooks

Subscribe to Webhook Events

Creates a webhook subscription for the specified event type. The hookUrl will receive POST requests when events occur.

POST
/v1/webhooks/subscribe

Creates a webhook subscription for the specified event type. The hookUrl will receive POST requests when events occur.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/webhooks/subscribe" \  -H "Content-Type: application/json" \  -d '{    "hookUrl": "http://example.com",    "event": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}