Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Headers

Idempotency-Key
string

Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). The same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

Create a webhook endpoint.

url
string
required

https URL, port 443 or 8443, publicly resolvable.

eventTypes
string[]
required

1-30 types available to your roles.

Required array length: 1 - 30 elements

Webhook type.

description
string | null

Up to 200 characters.

Maximum string length: 200

Response

Success.

Single-object envelope around WebhookEndpointWithSecrets.

data
object
required

A webhook endpoint with the secret(s) the operation generated.