Send a test event

curl --request POST \
  --url https://api.panoflow.io/v1/webhooks/{webhook_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "payment.completed"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'payment.completed'})
};

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

import requests

url = "https://api.panoflow.io/v1/webhooks/{webhook_id}/test"

payload = { "type": "payment.completed" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "wdl_01JBZ6G18CX5TFA05TGN3ZFVBB",
  "object": "webhook_delivery",
  "webhook_id": "whe_01JB7MFPJ2MY52K5A06KGSXKGS",
  "event_id": "evt_01JBZ6G18CX5TFA05TGN3ZFVBB",
  "event_type": "payment.completed",
  "livemode": false,
  "status": "succeeded",
  "attempts_count": 1,
  "response_status": 200,
  "latency_ms": 201,
  "attempts": [
    {
      "number": 1,
      "trigger": "test",
      "attempted_at": "2026-10-28T09:35:00Z",
      "response_status": 200,
      "latency_ms": 201
    }
  ],
  "created_at": "2026-10-28T09:35:00Z",
  "updated_at": "2026-10-28T09:35: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}

test

Send a test event

curl --request POST \
  --url https://api.panoflow.io/v1/webhooks/{webhook_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "payment.completed"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'payment.completed'})
};

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

import requests

url = "https://api.panoflow.io/v1/webhooks/{webhook_id}/test"

payload = { "type": "payment.completed" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "wdl_01JBZ6G18CX5TFA05TGN3ZFVBB",
  "object": "webhook_delivery",
  "webhook_id": "whe_01JB7MFPJ2MY52K5A06KGSXKGS",
  "event_id": "evt_01JBZ6G18CX5TFA05TGN3ZFVBB",
  "event_type": "payment.completed",
  "livemode": false,
  "status": "succeeded",
  "attempts_count": 1,
  "response_status": 200,
  "latency_ms": 201,
  "attempts": [
    {
      "number": 1,
      "trigger": "test",
      "attempted_at": "2026-10-28T09:35:00Z",
      "response_status": 200,
      "latency_ms": 201
    }
  ],
  "created_at": "2026-10-28T09:35:00Z",
  "updated_at": "2026-10-28T09:35: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}$

Body

application/json

Optional choice of event type.

type

string

One of the endpoint's enabled_events; defaults to the first. The event carries sample data and is not listed in /v1/events.

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

Example:

"payment.completed"

Response

Sent; see response_status.

One event delivered (or being delivered) to one endpoint, with every attempt. At least once, in order per endpoint, exponential backoff over the retry window ([Retry window] in the designs); then failed and the developer is emailed. 2xx = success. Kept 90 days, then summary only (bodies dropped).

string

required

Delivery id.

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

object

string

required

Always webhook_delivery.

Allowed value: "webhook_delivery"

webhook_id

string

required

Endpoint.

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

event_id

string

required

Event delivered (also the PanoFlow-Event-Id header).

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

event_type

string

required

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_]+)+$

Example:

"payment.completed"

livemode

boolean

required

Mode.

status

enum<string>

required

pending (queued), succeeded, retrying (failed, another automatic attempt is scheduled), failed (retry window over).

Available options:

pending,

succeeded,

retrying,

failed

attempts_count

integer

required

Attempts so far.

Required range: x >= 0

attempts

object[]

required

All attempts, oldest first.

Show child attributes

created_at

string<date-time>

required

Created.

Example:

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

updated_at

string<date-time>

required

Last attempt or state change.

Example:

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

response_status

integer

Status of the latest attempt.

Required range: 100 <= x <= 599

latency_ms

integer

Latency of the latest attempt.

Required range: x >= 0

next_retry_at

string<date-time>

When retrying: next automatic attempt.

Example:

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

request_body

string

Retrieve only: the exact signed JSON body sent.

response_body

string

Retrieve only: your server's latest response body, first 4 KB.

Maximum string length: 4096

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Send a test event

Authorizations

Headers

Path Parameters

Body

Response