Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Pass your API key as Authorization: Bearer sk_…. Mint a key from your dashboard's API-keys page.

Body

application/json
url
string
required

HTTPS URL Roughy will POST events to. Must be publicly routable — private, loopback, and link-local hosts are rejected. Max 2000 characters.

Maximum string length: 2000
event_types
string[]
required

Terminal-state event types to subscribe to: asset.failed, asset.pending_payment, asset.ready, cut.completed, cut.failed, render.cancelled, render.completed, render.failed, subtitle.completed, subtitle.failed. An empty list subscribes to every event type. Unknown types are rejected with 422.

description
string | null

Optional human label for your own reference.

Response

The newly-created webhook endpoint.

id
string
required

Webhook endpoint id.

url
string
required

The endpoint's delivery URL.

event_types
string[]
required

The event types this endpoint is subscribed to.

description
string | null

The endpoint's human label, if set.