Skip to content
Proud to collaborate with Microsoft for Startups

hook.update-redirect ​

Update webhook redirect configuration

Workflow for updating webhook redirect configuration.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-hookredirect
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo——
redirect_uuiduuidYes——
workflow_run_idstringNo—DAG-stamped parent run id
namestringNo——
descriptionstringNo——
enabledbooleanNo——
allowed_methodslistNo——
rate_limit_per_minuteintegerNo——
rate_limit_per_hourintegerNo——
event_retention_daysintegerNo——
tagsdictNo——
configurationdictNo——
regenerate_urlbooleanNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo——
redirect_uuiduuidNo——
workflow_run_idstringNo—DAG-stamped parent run id
namestringNo——
descriptionstringNo——
enabledbooleanNo——
allowed_methodslistNo——
rate_limit_per_minuteintegerNo——
rate_limit_per_hourintegerNo——
event_retention_daysintegerNo——
tagsdictNo——
configurationdictNo——
regenerate_urlbooleanNo——
signed_uuidstringNo——
old_signed_uuidstringNo——
public_urlstringNo——
updatedbooleanNo——
url_regeneratedbooleanNo——
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—
regenerating_urlNoNo—regenerate_url—
updatingNoNo—update—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
validatingvalidateupdating—
updatingupdateregenerating_url—
regenerating_urlregenerate_urlcompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
updatedSUCCESSRedirect was updatedredirect_uuid, updated
failedFAILURERedirect update 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.update-redirect",
  "initial_data": {
    "redirect_uuid": "value"
  }
}