WebhookEndpointCreate

An endpoint as POST /webhooks takes it. Fields not named here are ignored.

urlstring<uri>required

An https URL on a public host, up to 2,000 characters.

Possible values: <= 2000 characters

Example: https://hooks.fennlor.example/formfeed

eventsWebhookEvent[]

The events to receive; quota.* and storage.* only when listed.

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

Default value: ["render.completed","render.failed","job.completed","job.failed"]

environmentsstring[]

Render environments whose events the endpoint receives; both by default. Quota events are sent regardless.

Possible values: [live, test], >= 1

Default value: ["live","test"]

descriptionstringnullable

Your note on the endpoint, up to 200 characters.

Possible values: <= 200 characters

WebhookEndpointCreate

{
  "url": "https://hooks.fennlor.example/formfeed",
  "events": [
    "render.completed"
  ],
  "environments": [
    "live"
  ],
  "description": "string"
}