hook.list-redirects ​
List webhook redirects for an organization
List webhook redirects for an organization with optional filtering.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-hookredirect |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the organization to list redirects for |
enabled | boolean | No | — | Filter by enabled/disabled state |
q | string | No | — | Substring filter on redirect name (case-insensitive) |
limit | integer | No | — | Maximum number of results (default 50, max 200) |
offset | integer | No | — | Number of results to skip (default 0) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
redirects | list | Yes | — | List of redirect objects (UUID-only surface) |
total | integer | Yes | — | Total count without pagination |
limit | integer | Yes | — | Applied limit value |
offset | integer | Yes | — | Applied offset value |
error | string | No | — | Error message if organization_uuid not found |
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 | Redirects were listed | total, redirects |
failed | FAILURE | Redirect 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-redirects",
"initial_data": {
"organization_uuid": "value"
}
}