Test a video webhook

post

https://api.pixop.com/api/v1/webhooks/{id}/test

Sends a test event to the specified video webhook.

You may optionally provide a videoId and/or eventType. If videoId is omitted, a random UUID will be generated.
If eventType is not specified, one of the webhook’s configured event types will be selected at random.

If the webhook is inactive, or if the specified eventType is not among the webhook’s configured types, a 409 Conflict response is returned.

Each team can send up to 1000 test events within a 24-hour period.
If this limit is reached, further attempts to send test events will also result in a 409 Conflict response.

Test events are automatically deleted after 24 hours.

Path Params

uuid

required

The unique identifier for the object.

Query Params

videoId

uuid

Optional video ID to include in the test event. If omitted, a random UUID will be used.

eventType

string

enum

Optional event type to use for the test event. If omitted, one of the webhook’s configured event types is selected at random. If specified, it must match one of the webhook's configured event types.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

202Successfully retrieved webhook event details.

400Invalid request. Inspect the details of the error for more information.

401Authentication failed. Missing or invalid X-API-Key or basic authentication credentials.

403Access denied. You do not have the necessary permissions to access this resource.

404The requested resource could not be found.

409Conflict detected. The request could not be processed due to conflicting data.

429Too Many Requests. The rate limit for this resource has been exceeded.

500An unexpected error occurred on the server.