Get webhook
GET /api/webhooks/{id}
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
| Parameter | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | string | Yes |
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/YOUR_ID' \
--header "x-api-key: $ZVID_API_KEY"
Responses
HTTP 200
Endpoint including signing secret
Content type: application/json.
Required properties: webhook.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
response.webhook | Webhook | Yes |
Representative successful response response
{
"webhook": {
"id": "whk_abcdefghijklmnopqrst",
"url": "https://example.com/hooks/zvid",
"events": [
"render.completed"
],
"status": "active",
"secret": "whsec_example_not_a_real_secret"
}
}
HTTP 404
Not found No response body is defined.
Schema definitions
The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.
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.