Skip to main content

Create a webhook endpoint

POST 
/webhooks

Registers an https endpoint on a public host for the workspace's events. Without events it receives render.completed, render.failed, job.completed and job.failed; quota.* and storage.* events only when listed. A new endpoint is enabled. Every delivery is signed in Webhook-Signature (t=<unix time>,v1=<HMAC-SHA256 of "<t>.<body>">) with the secret the answer carries once; a delivery that fails is retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours. Needs webhook:manage, which new keys do not have by default. The plan sets how many endpoints the organisation has (one on Free, five on Starter, any number from Pro; disabled ones count, formfeed listen sessions do not), and one more answers 403 forbidden with feature: webhooks and limit.

Request​

Responses​

Created. The secret is returned once.

Response Headers
    Location

    Absolute URL of the new endpoint, for DELETE /webhooks/{id}.