List webhooks

GET /api/webhooks

Authentication

• Option 1: x-api-key: YOUR_API_KEY (header). API key for authentication. Create one in your dashboard.
• Option 2: Authorization: Bearer YOUR_ACCESS_TOKEN. Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.

Create API keys at app.zvid.io/api-keys. Keep credentials on your server.

Parameters

This operation has no path, query, or additional header parameters.

Request

The shell examples read credentials from ZVID_API_KEY (or ZVID_ACCESS_TOKEN for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.

This operation does not take a request body.

Request example

curl --request GET 'https://api.zvid.io/api/webhooks' \
  --header "x-api-key: $ZVID_API_KEY"

Responses

HTTP 200

Account endpoints and plan allowance

Content type: application/json.

Required properties: webhooks, usage.

Field	Type	Required	Description and constraints
response.webhooks	array of Webhook	Yes
response.usage	WebhookUsage	Yes

Nested field: response.webhooks

Array item: response.webhooks[]

Schema: Webhook.

Representative successful response response

{
  "webhooks": [],
  "usage": {
    "used": 0,
    "limit": 1,
    "planName": "Free"
  }
}

HTTP 401

Unauthorized

Content type: application/json.

Unknown properties are rejected. Required properties: error.

Field	Type	Required	Description and constraints
response.error	string	Yes	Error type
response.message	string	No	Human-readable error message

Schema definitions

The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.

WebhookList

Required properties: webhooks, usage.

Field	Type	Required	Description and constraints
WebhookList.webhooks	array of Webhook	Yes
WebhookList.usage	WebhookUsage	Yes

Nested field: WebhookList.webhooks

Array item: WebhookList.webhooks[]

Schema: Webhook.

Webhook

Required properties: id, url, events, status.

Field	Type	Required	Description and constraints
Webhook.id	string	Yes
Webhook.url	string	Yes
Webhook.description	string	No
Webhook.events	array of "render.completed" / "render.failed"	Yes
Webhook.status	"active" / "disabled"	Yes
Webhook.secret	string	No	Returned by creation and single-webhook lookup; omitted from list/update responses.
Webhook.consecutiveFailures	integer	No
Webhook.lastSuccessAt	string OR null	No	At least one listed alternative must match.
Webhook.lastFailureAt	string OR null	No	At least one listed alternative must match.
Webhook.lastFailureReason	string OR null	No	At least one listed alternative must match.
Webhook.createdAt	string	No
Webhook.updatedAt	string	No

Nested field: Webhook.events

Array item: Webhook.events[]

Type: "render.completed" / "render.failed".

Nested field: Webhook.lastSuccessAt

At least one listed alternative must match.

anyOf alternative 1

Type: string.

anyOf alternative 2

Type: null.

Nested field: Webhook.lastFailureAt

At least one listed alternative must match.

anyOf alternative 1

Type: string.

anyOf alternative 2

Type: null.

Nested field: Webhook.lastFailureReason

At least one listed alternative must match.

anyOf alternative 1

Type: string.

anyOf alternative 2

Type: null.

WebhookUsage

Required properties: used, limit, planName.

Field	Type	Required	Description and constraints
WebhookUsage.used	integer	Yes
WebhookUsage.limit	integer	Yes
WebhookUsage.planName	string	Yes

AuthenticationError

Unknown properties are rejected. Required properties: error.

Field	Type	Required	Description and constraints
AuthenticationError.error	string	Yes	Error type
AuthenticationError.message	string	No	Human-readable error message

Related resources

• OpenAPI specification
• Project payload schema
• Quick Start
• Authentication guide