Current (2025-04-01)Merchants API

Webhooks Management

GET
/public/2025-04-01/webhooks
x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/public/2025-04-01/webhooks"
{  "success": true,  "data": [    {      "id": "string",      "event": "string",      "url": "string"    }  ]}
POST
/public/2025-04-01/webhooks
x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

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

curl -X POST "https://example.com/public/2025-04-01/webhooks" \  -H "Content-Type: application/json" \  -d '{    "event": "webhook.test",    "url": "http://example.com"  }'
{  "success": true,  "id": "string"}
DELETE
/public/2025-04-01/webhooks/{id}
x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

In: header

Path Parameters

id*string

The Webhook id to delete

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/public/2025-04-01/webhooks/string"
{  "success": true}
Was this page helpful?