Appearance
hook.purge-redirect ​
Permanently purge a soft-deleted webhook redirect
Hard-delete a soft-deleted webhook redirect and, explicitly, its events.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-hookredirect |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
redirect_uuid | uuid | Yes | — | — |
confirm_purge | boolean | Yes | — | Must be true to permanently delete the soft-deleted redirect |
purge_events | boolean | No | False | Must be true when stored events exist for this redirect |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
redirect_uuid | uuid | No | — | — |
confirm_purge | boolean | No | — | Must be true to permanently delete the soft-deleted redirect |
purge_events | boolean | No | False | Must be true when stored events exist for this redirect |
redirect_name | string | No | — | — |
deleted_at | string | No | — | — |
event_count | integer | No | — | — |
events_purged_count | integer | No | — | — |
purged | boolean | No | — | — |
purged_at | string | No | — | — |
failure_reason | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
error_message | string | No | — | — |
success | boolean | No | — | — |
failed_at | string | No | — | — |
failure_type | string | No | — | — |
retried_from | string | No | — | — |
retry_count | integer | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
validating | Yes | No | — | validate | — |
purging | No | No | — | purge | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
validating | validate | purging | — |
purging | purge | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
purged | SUCCESS | Redirect was permanently purged | redirect_uuid, purged_at |
failed | FAILURE | Redirect purge failed | failure_reason |
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.purge-redirect",
"initial_data": {
"redirect_uuid": "value",
"confirm_purge": true
}
}