Skip to main content

Create an endpoint

Availability pending. Check applicability.

Object and complete fields · Authentication, amounts and errors · Integration guide

POST /v1/webhook-endpoints

Creates a Checkout/Refund notification endpoint and generates its signing secret.

Attributes​

AttributeLocationTypeRequiredDescription
Idempotency-KeyheaderstringYesUnique key for this operation; reuse the original value when retrying
urlbodystringYesPublicly reachable receiver URL; live requires HTTPS; test also permits HTTP
enabledbodybooleanNoWhether delivery is enabled; defaults to true

Request example​

POST /v1/webhook-endpoints
Authorization: Bearer inv_test_...
Content-Type: application/json
Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000
{
"url": "https://merchant.example.com/webhooks/invisi",
"enabled": true
}

Response example​

200 OK, with the complete Webhook Endpoint object including the signing secret. Save secret; subsequent list and update responses omit it.

{
"id": "we_example",
"url": "https://merchant.example.com/webhooks/invisi",
"enabled": true,
"secret": "whsec_...",
"created_at": "2026-10-15T08:00:00Z",
"updated_at": "2026-10-15T08:00:00Z"
}

Business error codes