chatformdocs
API referenceV1

Create a webhook endpoint. The signing secret is returned ONCE

POST
/v1/webhooks

Authorization

AuthorizationBearer <token>

A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.

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/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "events": [      "string"    ]  }'
{  "id": "string",  "url": "string",  "events": [    "string"  ],  "formId": "string",  "active": true,  "consecutiveFailures": 0,  "createdAt": 0,  "secretPreview": "string",  "secret": "string",  "property1": null,  "property2": null}