New Chargeflow docs. Everything for merchants, platforms, and the API in one place.
Log in
Legacy (2024-03-18)Merchants API

Webhooks Management

Webhook configuration and management

DELETE
/public/2024-03-18/webhooks/{id}
x-api-key<token>

Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.

In: header

Path Parameters

id*string

The Webhook id to delete

Response Body

application/json

curl -X DELETE "https://example.com/public/2024-03-18/webhooks/123e4567-e89b-12d3-a456-426614174000"
{  "success": true}
GET
/public/2024-03-18/webhooks
x-api-key<token>

Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.

In: header

Response Body

application/json

curl -X GET "https://example.com/public/2024-03-18/webhooks"
{  "success": true,  "data": [    {      "id": "string",      "event": "webhook.test",      "url": "string",      "active": true,      "version": "string"    }  ]}
POST
/public/2024-03-18/webhooks
x-api-key<token>

Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/public/2024-03-18/webhooks" \  -H "Content-Type: application/json" \  -d '{    "event": "webhook.test",    "url": "http://example.com"  }'
{  "success": true,  "id": "string"}
Was this page helpful?