Webhook Endpoints

Register Webhook

Changed on

Registers an HTTPS endpoint that receives the listed events. Event names and payload schemas are in the webhooks section of this API reference (and in the MCP resource blindpay://webhooks/events). Deliveries are signed with Svix; read the signing secret with Retrieve Webhook Secret and verify every delivery.

post/v1/instances/{instance_id}/webhook-endpoints

Request

  • Base URL: https://blindpay.com (the document declares no server; this is the origin it was published from)
  • URL: https://blindpay.com/v1/instances/{instance_id}/webhook-endpoints
  • Auth: HTTP bearer

Path parameters

instance_idstring required
Example:in_000000000000

Headers

Idempotency-Keystring

Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

urlstring uri required
eventsstring[] required

Example request

{
  "url": "https://example.com/webhook",
  "events": [
    "customer.new"
  ]
}

Response

Create webhook endpoint

idstring required

Example response

{
  "id": "we_000000000000"
}

Changes