WebhookEndpoint

A registered endpoint.

idstring<uuid>required

The endpoint id, a UUID.

Example: 3f2b8c1e-7a4d-4e9b-9c0a-5d6e7f809a1b

urlstring<uri>required

eventsWebhookEvent[]required

Possible values: [render.completed, render.failed, job.completed, job.failed, quota.warning, quota.exceeded, storage.delivered, storage.failed]

environmentsstring[]required

Possible values: [live, test]

enabledbooleanrequired

Whether events are delivered. A new endpoint is enabled; Formfeed switches it off after five events in a row whose retries were exhausted.

descriptionstringnullablerequired

consecutive_failuresintegerrequired

Events in a row whose retries were exhausted; five switch the endpoint off.

Possible values: >= 0

secretstring

The signing secret (whsec_…). Only in the answer of POST /webhooks; verify each delivery's Webhook-Signature with it.

Example: whsec_9b1f3c7a2e5d4b6c8a0f1e3d5c7b9a2e4f6d8c0b1a3e5f7d

created_atstring<date-time>required

updated_atstring<date-time>required

WebhookEndpoint

{
  "id": "3f2b8c1e-7a4d-4e9b-9c0a-5d6e7f809a1b",
  "url": "string",
  "events": [
    "render.completed"
  ],
  "environments": [
    "live"
  ],
  "enabled": true,
  "description": "string",
  "consecutive_failures": 0,
  "secret": "whsec_9b1f3c7a2e5d4b6c8a0f1e3d5c7b9a2e4f6d8c0b1a3e5f7d",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}