Register a webhook endpoint
Registers the https URL that receives events in one mode, and returns its
signing secret this once. Deliveries are signed
Volume-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<body>">. A
live endpoint needs an active account. One registration per URL.
With an API key, in the key's mode: an integration can register its own endpoint when it deploys. Logged in, name the mode.
Authorization
ApiKey A merchant API key, sent as Authorization: Bearer vk_live_…. The prefix
selects the mode: vk_test_ for testnets, vk_live_ for real money.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/webhook_endpoints" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com" }'{ "object": "webhook_endpoint", "id": "string", "livemode": true, "url": "string", "description": "string", "enabled_events": [ "checkout.payment_detected" ], "status": "active", "created_at": "2019-08-24T14:15:22Z", "secret": "string"}