Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "whd_a1b2c3",
"webhookId": "wh_5c1a90",
"eventType": "ping",
"status": "pending",
"attempts": 0,
"nextRetryAt": null,
"responseStatus": null,
"createdAt": "2026-07-12T09:45:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Webhooks
Send a test delivery
Sends a sample event to the endpoint so you can confirm your receiver is reachable and verifies signatures correctly. Returns the resulting delivery record, whose status updates as the attempt completes.
POST
/
webhooks
/
{id}
/
test
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "whd_a1b2c3",
"webhookId": "wh_5c1a90",
"eventType": "ping",
"status": "pending",
"attempts": 0,
"nextRetryAt": null,
"responseStatus": null,
"createdAt": "2026-07-12T09:45:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
webhooks:write
Manage webhook endpoints.
Path Parameters
The webhook endpoint's id to send a test delivery to.