Skip to main content
POST
/
v1
/
webhook-endpoints
Create a webhook endpoint
curl --request POST \
  --url https://roughy-api-staging.fly.dev/v1/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "event_types": [
    "<string>"
  ],
  "description": "<string>"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "event_types": [
    "<string>"
  ],
  "description": "<string>"
}

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.

​
event_types
string[]
required

Terminal-state event types to subscribe to, e.g. cut.completed, cut.failed, render.completed, render.failed, render.cancelled, asset.ready, asset.failed.

​
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.