stile
PlaygroundWebhook endpoints

Create a webhook endpoint

The signing secret is returned only in this response. Store it securely.

POST
/v1/webhook_endpoints

Authorization

BearerAuth
AuthorizationBearer <token>

Use a secret API key as the bearer token. Keys are prefixed with vk_test_ (test mode) or vk_live_ (live mode).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "http://localhost:3000/v1/webhook_endpoints" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "enabled_events": [      "string"    ]  }'
{
  "id": "string",
  "object": "webhook_endpoint",
  "url": "string",
  "enabled_events": [
    "string"
  ],
  "status": "enabled",
  "api_version": "string",
  "description": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "created": 0,
  "updated": 0,
  "secret": "string"
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "request_id": "string"
  }
}