Skip to content
Proud to collaborate with Microsoft for Startups

hook.create-redirect ​

Create new webhook redirect with signed UUID

Workflow for creating webhook redirects.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-hookredirect
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—DAG-stamped parent run id
organization_uuiduuidNo—Organization UUID supplied by the Workflow API context
namestringYes—Redirect name
descriptionstringNo—Optional redirect description
enabledbooleanNoTrueWhether the redirect is enabled
allowed_methodslistNo['POST']Allowed HTTP methods
rate_limit_per_minuteintegerNo100Per-minute rate limit
rate_limit_per_hourintegerNo1000Per-hour rate limit
event_retention_daysintegerNo7Webhook event retention in days
tagsdictNo{}User-defined tags
configurationdictNo{}Redirect configuration such as forward_url

Output Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—DAG-stamped parent run id
organization_uuiduuidNo—Organization UUID supplied by the Workflow API context
namestringNo—Redirect name
descriptionstringNo—Optional redirect description
enabledbooleanNoTrueWhether the redirect is enabled
allowed_methodslistNo['POST']Allowed HTTP methods
rate_limit_per_minuteintegerNo100Per-minute rate limit
rate_limit_per_hourintegerNo1000Per-hour rate limit
event_retention_daysintegerNo7Webhook event retention in days
tagsdictNo{}User-defined tags
configurationdictNo{}Redirect configuration such as forward_url
signed_uuidstringNo——
redirect_uuidstringNo——
public_urlstringNo——
createdbooleanNo——
failure_reasonstringNo——
failed_stepjsonNo——
failed_layerjsonNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——
error_messagestringNo——
successbooleanNo——
failed_atstringNo——
failure_typestringNo——
retried_fromstringNo——
retry_countintegerNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
validatingYesNo—validate—
creatingNoNo—create—
generating_signed_uuidNoNo—generate_signed_uuid—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
validatingvalidategenerating_signed_uuid—
generating_signed_uuidgenerate_signed_uuidcreating—
creatingcreatecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
createdSUCCESSRedirect was createdredirect_uuid, public_url
failedFAILURERedirect creation failedfailure_reason

Business Errors ​

CodeMessage Template
HOOK_REDIRECT_WORKFLOW_ERRORHook redirect workflow failed

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "hook.create-redirect",
  "initial_data": {
    "name": "value"
  }
}