Skip to main content
POST
Register webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required
Required string length: 1 - 2083
events
enum<string>[]

A job or asset lifecycle event a webhook subscription can receive.

Values:

  • render.queued — A render job was accepted and queued.
  • render.processing — A render job started processing.
  • render.completed — A render job finished successfully.
  • render.failed — A render job failed.
  • render.cancelled — A render job was cancelled.
  • task.queued — A task job was accepted and queued.
  • task.processing — A task job started processing.
  • task.completed — A task job finished successfully.
  • task.failed — A task job failed.
  • task.cancelled — A task job was cancelled.
  • asset.ready — An external source finished ingesting into Framelane storage.
Available options:
render.queued,
render.processing,
render.completed,
render.failed,
render.cancelled,
task.queued,
task.processing,
task.completed,
task.failed,
task.cancelled,
asset.ready
enabled
boolean
default:true

Response

Successful Response

Returned at create-time and after rotate-secret -- includes plaintext secret.

id
string
required
url
string
required
events
string[]
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
secret
string
required