Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

Idempotency-Key
string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: 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

New webhook endpoint.

url
string<uri>
required

Receiver URL: https, port 443 or 8443, publicly resolvable.

eventTypes
enum<string>[]
required

Event types (1-30).

Required array length: 1 - 30 elements

A consumer webhook type. Billing types (invoice-*, payment-failed, payment-method-deactivated) need view-consumer-billing, price-terms-* types need view-consumer-pricing. Treat as an open set: new values may be added.

Available options:
redemption-created,
redemption-voided,
redemption-entity-created,
redemption-link-exhausted,
redemption-link-expired,
catalog-voucher-set-available,
catalog-voucher-set-updated,
catalog-voucher-set-activation-scheduled,
catalog-voucher-set-activated,
catalog-voucher-set-deactivation-scheduled,
catalog-voucher-set-deactivated,
catalog-voucher-set-unavailable,
catalog-voucher-set-stock-low,
catalog-voucher-set-depleted,
webhook-endpoint-test,
invoice-finalised,
invoice-paid,
invoice-overdue,
invoice-voided,
payment-failed,
payment-method-deactivated,
price-terms-change-scheduled,
price-terms-acceptance-required,
price-terms-accepted
description
string | null

Description (at most 200 characters).

Maximum string length: 200

Response

Created

Single-object envelope around a WebhookEndpointWithSecrets.

data
object
required

A webhook endpoint with newly issued secrets.