Skip to main content
POST
Create webhook endpoint

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Body

application/json
url
string
required

Publicly routable https receiver URL.

description
string | null
event_types
string[] | null

Event types to receive (e.g. ["deployment.serving", "job.completed"]). Omit or pass [] to subscribe to all events.

Response

The created endpoint. This is the ONLY response that includes the full signing secret.

object
string
required
id
string
required
url
string
required
secret
string
required

Full "whsec_..." signing secret on create ONLY; masked on every other read (use GET /v1/webhooks/{id}/secret to retrieve it again).

event_types
string[]
required

Empty = subscribed to all event types.

consecutive_failures
integer<int32>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
disabled_at
string<date-time> | null

Set when the endpoint is disabled (manually or automatically after 50 consecutive delivery failures). Disabled endpoints receive no events.