Enable a webhook endpoint

curl --request POST \
  --url https://api.panoflow.io/v1/webhooks/{webhook_id}/enable \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/webhooks/{webhook_id}/enable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "whe_01JB7MFPJ2MY52K5A06KGSXKGS",
  "object": "webhook_endpoint",
  "livemode": false,
  "description": "Production backend",
  "url": "https://api.adaezelogistics.ng/webhooks/panoflow",
  "enabled_events": [
    "collection.received",
    "payment.created",
    "payment.completed",
    "payment.failed"
  ],
  "status": "enabled",
  "health": "healthy",
  "stats_7d": {
    "success_rate_bps": 9730,
    "events_sent": 37,
    "failed": 1,
    "avg_response_ms": 210
  },
  "last_delivery_at": "2026-10-28T08:42:11Z",
  "secret_last4": "3kQa",
  "created_by": {
    "type": "user",
    "id": "usr_01JB2KDPSWW8D5JCEBFYV7ESJS",
    "name": "Tolu Martins"
  },
  "created_at": "2026-10-12T09:00:00Z",
  "updated_at": "2026-10-12T09:00:00Z"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

POST

webhooks

{webhook_id}

enable

Enable a webhook endpoint

curl --request POST \
  --url https://api.panoflow.io/v1/webhooks/{webhook_id}/enable \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/webhooks/{webhook_id}/enable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "whe_01JB7MFPJ2MY52K5A06KGSXKGS",
  "object": "webhook_endpoint",
  "livemode": false,
  "description": "Production backend",
  "url": "https://api.adaezelogistics.ng/webhooks/panoflow",
  "enabled_events": [
    "collection.received",
    "payment.created",
    "payment.completed",
    "payment.failed"
  ],
  "status": "enabled",
  "health": "healthy",
  "stats_7d": {
    "success_rate_bps": 9730,
    "events_sent": 37,
    "failed": 1,
    "avg_response_ms": 210
  },
  "last_delivery_at": "2026-10-28T08:42:11Z",
  "secret_last4": "3kQa",
  "created_by": {
    "type": "user",
    "id": "usr_01JB2KDPSWW8D5JCEBFYV7ESJS",
    "name": "Tolu Martins"
  },
  "created_at": "2026-10-12T09:00:00Z",
  "updated_at": "2026-10-12T09:00:00Z"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

Idempotency-Key

string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

webhook_id

string

required

Webhook endpoint id.

Pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$

Response

Enabled.

A customer URL that receives signed event POSTs. Sandbox and live endpoints are separate: an endpoint gets events of its own mode only, and the mode is the credential's.

string

required

Endpoint id.

Pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$

object

string

required

Always webhook_endpoint.

Allowed value: "webhook_endpoint"

livemode

boolean

required

Mode of the events it receives.

description

string

required

Name shown in the list ("Production backend").

Required string length: 1 - 80

url

string<uri>

required

HTTPS URL.

Maximum string length: 2048

Pattern: ^https://

enabled_events

string[]

required

Event types sent here.

Minimum array length: 1

Event type, <resource>.<event> (e.g. payment.completed). The catalogue is asyncapi/webhooks.yaml and GET /event-types; clients must tolerate new types.

Pattern: ^[a-z_]+(\.[a-z_]+)+$

status

enum<string>

required

enabled or disabled (by a person; nothing is sent, nothing queues).

Available options:

enabled,

disabled

health

enum<string>

required

waiting: no deliveries yet. healthy. failing: the last 3 deliveries failed (the developer is emailed "webhook failing").

Available options:

waiting,

healthy,

failing

stats_7d

object

required

Delivery stats over the last 7 days.

Show child attributes

secret_last4

string

required

Last four characters of the signing secret.

created_by

object

required

Who added it.

Show child attributes

created_at

string<date-time>

required

Created.

Example:

"2026-10-27T08:41:00Z"

updated_at

string<date-time>

required

Last change.

Example:

"2026-10-27T08:41:00Z"

failing_since

string<date-time>

When health became failing.

Example:

"2026-10-27T08:41:00Z"

last_delivery_at

string<date-time>

Last attempt.

Example:

"2026-10-27T08:41:00Z"

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Enable a webhook endpoint

Authorizations

Headers

Path Parameters

Response