Skip to content
Proud to collaborate with Microsoft for Startups

hook.list-redirects ​

List webhook redirects for an organization

List webhook redirects for an organization with optional filtering.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-hookredirect
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization to list redirects for
enabledbooleanNo—Filter by enabled/disabled state
qstringNo—Substring filter on redirect name (case-insensitive)
limitintegerNo—Maximum number of results (default 50, max 200)
offsetintegerNo—Number of results to skip (default 0)

Output Schema ​

FieldTypeRequiredDefaultDescription
redirectslistYes—List of redirect objects (UUID-only surface)
totalintegerYes—Total count without pagination
limitintegerYes—Applied limit value
offsetintegerYes—Applied offset value
errorstringNo—Error message if organization_uuid not found
error_typestringNo—Error-as-field envelope populated when query() raises.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

Outcomes ​

OutcomeTypeDescriptionState Data Keys
listedSUCCESSRedirects were listedtotal, redirects
failedFAILURERedirect listing failederror

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.list-redirects",
  "initial_data": {
    "organization_uuid": "value"
  }
}