Appearance
hook.list-events ​
Read-only list and get inspection for webhook events
Inspect webhook events without changing delivery state.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-hookredirect |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
redirect_uuid | uuid | No | — | — |
event_uuid | uuid | No | — | — |
workflow_uuid | string | No | — | — |
delivery_status | string | No | — | — |
limit | integer | No | — | — |
offset | integer | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
events | list | Yes | — | — |
total | integer | Yes | — | — |
limit | integer | Yes | — | — |
offset | integer | Yes | — | — |
error | string | No | — | — |
error_type | string | No | — | Error-as-field envelope populated when query() raises. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
listed | SUCCESS | Events were listed | total, events |
failed | FAILURE | Event listing failed | error |
Business Errors ​
| Code | Message Template |
|---|---|
HOOK_REDIRECT_WORKFLOW_ERROR | Hook redirect workflow failed |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "hook.list-events",
"initial_data": {
"organization_uuid": "value"
}
}