SettleFlow API
API ReferenceWebhook configuration

Create a webhook configuration

POST
/webhooks/config

Registers a new webhook endpoint to receive event notifications.

X-Api-Key<token>

Merchant API key for authentication

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

curl -X POST "https://example.com/webhooks/config" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/webhooks/settleflow",    "events": [      "ATTEMPT_CAPTURED",      "ATTEMPT_FAILED"    ],    "enabled": true  }'
{  "id": "whc_a1b2c3d4",  "url": "https://example.com/webhooks/settleflow",  "events": [    "ATTEMPT_CAPTURED",    "ATTEMPT_FAILED"  ],  "enabled": true,  "environment": "live",  "created_at": "2026-07-17T10:00:00.000Z",  "updated_at": "2026-07-17T10:00:00.000Z"}