Skip to content
Proud to collaborate with Microsoft for Startups

hook.receive-webhook ​

Handle webhook receipt, storage, and forwarding to DevKit

Complete webhook delivery workflow.

Tracks full lifecycle from public endpoint receipt through DevKit forwarding to local development server.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-hookredirect
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—DAG-stamped parent run id
signed_uuidstringYes—Signed public redirect token in token.signature format
methodstringNoPOST—
pathstringNo/—
headersjsonNo{}—
bodystringNo——
raw_body_base64stringNo—Exact raw request body as base64 for downstream signature verification
query_paramsjsonNo{}—
content_typestringNo——
source_ipstringNo——
user_agentstringNo——
skip_hmac_validationbooleanNoFalseInternal replay-only bypass for HMAC verification
replay_of_event_uuidstringNo—Original event UUID when this run is a replay

Output Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—DAG-stamped parent run id
signed_uuidstringNo—Signed public redirect token in token.signature format
methodstringNoPOST—
pathstringNo/—
headersjsonNo{}—
bodystringNo——
raw_body_base64stringNo—Exact raw request body as base64 for downstream signature verification
query_paramsjsonNo{}—
content_typestringNo——
source_ipstringNo——
user_agentstringNo——
skip_hmac_validationbooleanNoFalseInternal replay-only bypass for HMAC verification
replay_of_event_uuidstringNo—Original event UUID when this run is a replay
redirect_uuidstringNo——
organization_uuidstringNo——
validation_passedbooleanNo——
rate_limit_checked_atstringNo——
event_uuidstringNo——
stored_atstringNo——
dispatch_workflow_typestringNo——
dispatch_workflow_uuidstringNo——
dispatch_statusstringNo——
dispatch_errorstringNo——
dispatch_outputjsonNo——
hook_responsejsonNo——
challenge_handshakebooleanNo——
queued_atstringNo——
ready_for_pickupbooleanNo——
picked_up_atstringNo——
picked_up_bystringNo——
devkit_client_refstringNo——
ack_timeout_workflow_uuidstringNo——
forwarded_atstringNo——
delivery_time_secondsfloatNo——
devkit_responsejsonNo——
completed_atstringNo——
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
receivedYesNo—validate—
forwardedNoNo—complete—
pending_forwardNoNo———
picked_upNoNo———
storedNoNo—queue_for_forward—
validatedNoNo—store—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
receivedvalidatevalidated—
validatedstorestored—
validatedchallenge_completecompleted—
storedqueue_for_forwardpending_forward—
pending_forwardmark_picked_uppicked_up—
picked_upmark_forwardedforwarded—
forwardedcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "hook.receive-webhook",
  "initial_data": {
    "signed_uuid": "value"
  }
}