Skip to main content

WebhookEndpointUpdate

What PUT /webhooks/{id} changes: any of these fields alone, the others stay. At least one is needed (400 otherwise); other fields are ignored.

urlstring<uri>

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

Possible values: <= 2000 characters

eventsWebhookEvent[]

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

environmentsstring[]

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

enabledboolean

false switches the endpoint off; true switches it on again and resets consecutive_failures.

descriptionstringnullable

Up to 200 characters; null clears it.

Possible values: <= 200 characters

WebhookEndpointUpdate
{
"url": "string",
"events": [
"render.completed"
],
"environments": [
"live"
],
"enabled": true,
"description": "string"
}