API ReferenceChangelog
Log In
API Reference

Create a new webhook

post
https://api.pixop.com/api/v1/webhooks

Creates a new webhook for the selected team. Webhooks are used to receive notifications about events on the Pixop Platform.

Each team can have up to 10 active webhooks. If this limit is reached, attempts to create an additional active webhook will result in a 409 Conflict response.

Query Params
uuid

Specifies the team ID for the operation.

  • For POST requests, assigns the new object to the specified team.
  • For GET requests, retrieves data for the specified team. If not provided, defaults to the ID of the default team associated with the API key.
Body Params

Fields required for creating a webhook.

string
required
length between 1 and 47

A user-defined name to help identify and organize the webhook.

string
length between 1 and 255

A user-defined description providing context about the webhook’s purpose or usage.

string
required
length between 1 and 4096

A URL that must use HTTPS and point to a publicly reachable address. Only port 443 is allowed for HTTPS URLs. The following addresses are not allowed:

  • Loopback (e.g., 127.x.x.x, ::1)
  • Site-local (RFC1918) addresses (e.g., 10.x.x.x, 192.168.x.x, 172.16–31.x.x, IPv6 unique-local)
  • Link-local addresses (e.g., 169.254.x.x, fe80::/10)
  • Multicast addresses (e.g., 224.0.0.0–239.255.255.255, ff00::/8)

The server will parse the URL, resolve its host, and reject any internal or non-public address.

integer
required
1 to 1000
Defaults to 10

The maximum number of requests per second that Pixop will send to the webhook URL.
This rate limit is enforced to avoid overwhelming the receiving system.

integer
required
0 to 1440

The maximum total duration, in minutes, over which retry attempts will be made for a failed webhook event.
Once this threshold is reached, no further retries will be performed.

eventTypes
array of objects
required
length between 1 and 22
Defaults to null

A list of event types the webhook is subscribed to.
The webhook will receive notifications for all specified event types. Each event type corresponds to a specific stage or outcome in the processing pipeline.

  • video_in.started: Input video copy operation has started
  • video_in.done: Input video copy operation completed
  • video_in.failed: Input video copy operation failed
  • video_in_ingestion.started: Ingestion of input video has started
  • video_in_ingestion.done: Ingestion of input video completed
  • video_in_ingestion.failed: Ingestion of input video failed
  • clip_processing.started: Video clip processing has started
  • clip_processing.done: Video clip processing completed
  • clip_processing.failed: Video clip processing failed
  • clip_ingestion.started: Ingestion of video clip has started
  • clip_ingestion.done: Ingestion of video clip completed
  • clip_ingestion.failed: Ingestion of video clip failed
  • video_processing.started: Video processing has started
  • video_processing.done: Video processing completed
  • video_processing.failed: Video processing failed
  • video_processing_ingestion.started: Ingestion of processed video has started
  • video_processing_ingestion.done: Ingestion of processed video completed
  • video_processing_ingestion.failed: Ingestion of processed video failed
  • video_out.started: Output video copy operation has started
  • video_out.done: Output video copy operation completed
  • video_out.failed: Output video copy operation failed
  • video.deleted: Video has been deleted
eventTypes*
boolean
required

Indicates whether the webhook is currently active and eligible to receive events.
Inactive webhooks will not receive any event notifications.

Responses

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago