hook.create-redirect ​
Create new webhook redirect with signed UUID
Workflow for creating webhook redirects.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-hookredirect |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_id | string | No | — | DAG-stamped parent run id |
organization_uuid | uuid | No | — | Organization UUID supplied by the Workflow API context |
name | string | Yes | — | Redirect name |
description | string | No | — | Optional redirect description |
enabled | boolean | No | True | Whether the redirect is enabled |
allowed_methods | list | No | ['POST'] | Allowed HTTP methods |
rate_limit_per_minute | integer | No | 100 | Per-minute rate limit |
rate_limit_per_hour | integer | No | 1000 | Per-hour rate limit |
event_retention_days | integer | No | 7 | Webhook event retention in days |
tags | dict | No | {} | User-defined tags |
configuration | dict | No | {} | Redirect configuration such as forward_url |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_id | string | No | — | DAG-stamped parent run id |
organization_uuid | uuid | No | — | Organization UUID supplied by the Workflow API context |
name | string | No | — | Redirect name |
description | string | No | — | Optional redirect description |
enabled | boolean | No | True | Whether the redirect is enabled |
allowed_methods | list | No | ['POST'] | Allowed HTTP methods |
rate_limit_per_minute | integer | No | 100 | Per-minute rate limit |
rate_limit_per_hour | integer | No | 1000 | Per-hour rate limit |
event_retention_days | integer | No | 7 | Webhook event retention in days |
tags | dict | No | {} | User-defined tags |
configuration | dict | No | {} | Redirect configuration such as forward_url |
signed_uuid | string | No | — | — |
redirect_uuid | string | No | — | — |
public_url | string | No | — | — |
created | boolean | 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 | — |
creating | No | No | — | create | — |
generating_signed_uuid | No | No | — | generate_signed_uuid | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
validating | validate | generating_signed_uuid | — |
generating_signed_uuid | generate_signed_uuid | creating | — |
creating | create | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
created | SUCCESS | Redirect was created | redirect_uuid, public_url |
failed | FAILURE | Redirect creation 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.create-redirect",
"initial_data": {
"name": "value"
}
}