Skip to content
Proud to collaborate with Microsoft for Startups

webhook.endpoint.create-verify-and-replay ​

Create a webhook redirect endpoint, verify delivery settings, replay a test event, and acknowledge the result.

Create a webhook redirect endpoint, verify delivery settings, replay a test event, and acknowledge the result.

Overview ​

PropertyValue
Workflow typeDag
LibraryApp-hookredirect
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—DAG-stamped parent run id.
organization_uuiduuidYes—Organization UUID for tenant isolation.
actorstringNo—User or service actor initiating the workflow.
idempotency_keystringNo—Caller-supplied idempotency key for safe retries.
dry_runbooleanNo—Validate and plan without mutating external resources.
endpoint_namestringYes—Webhook endpoint name.
target_urlstringYes—Webhook target URL.
secret_refstringNo—Signing secret reference.
test_eventjsonNo—Test event payload.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization uuid.
workflow_run_uuiduuidNo—Workflow run uuid.
statusstringNo—Status.
summaryjsonNo—Summary.
resource_refsjsonNo—Resource refs.
warningslistNo—Warnings.
completed_atstringNo—Completed at.
compensation_triggerstringNo—Compensation trigger.
compensation_resultsjsonNo—Compensation results.
hook_create_redirectjsonNo—Output state_data from DAG step hook_create_redirect.
hook_receive_webhookjsonNo—Output state_data from DAG step hook_receive_webhook.
hook_replay_eventjsonNo—Output state_data from DAG step hook_replay_event.
hook_acknowledge_eventjsonNo—Output state_data from DAG step hook_acknowledge_event.
hook_expire_pending_eventsjsonNo—Output state_data from DAG step hook_expire_pending_events.
failure_reasonstringNo—Failure reason.
failed_stepjsonNo—Failed step.
failed_layerjsonNo—Failed layer.
failed_at_statestringNo—Failed at state.
errorstringNo—Error.
error_typestringNo—Error type.
failed_atstringNo—Failed at.

DAG Layers ​

#LayerStepsCompensation
101_hook_create_redirecthook.create-redirect—
202_hook_receive_webhookhook.receive-webhook—
303_hook_replay_eventhook.replay-event—
404_hook_acknowledge_eventhook.acknowledge-event—
505_hook_expire_pending_eventshook.expire-pending-events—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
hook.create-redirecthook_create_redirect
hook.receive-webhookhook_receive_webhook
hook.replay-eventhook_replay_event
hook.acknowledge-eventhook_acknowledge_event
hook.expire-pending-eventshook_expire_pending_events

API Usage ​

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

{
  "workflow_type": "webhook.endpoint.create-verify-and-replay",
  "initial_data": {
    "organization_uuid": "value",
    "endpoint_name": "value",
    "target_url": "value"
  }
}