Skip to content
Proud to collaborate with Microsoft for Startups

hook.acknowledge-event ​

Acknowledge webhook event delivery from DevKit to local target

Acknowledge that DevKit forwarded a webhook event to its local target.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-hookredirect
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—DAG-stamped parent run id
redirect_uuiduuidYes—UUID of the WebhookRedirect that received the event
event_uuiduuidYes—UUID of the WebhookEvent being acknowledged
local_status_codeintegerYes—HTTP status returned by the local target (0 = no response)
local_response_bodystringNo—Truncated body returned by the local target
forwarded_atstringNo—ISO-8601 timestamp the DevKit forwarded the event
error_messagestringNo—Error message when the local target failed

Output Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—DAG-stamped parent run id
redirect_uuidstringNo——
event_uuidstringNo——
local_status_codeintegerNo——
local_response_bodystringNo——
forwarded_atstringNo——
acknowledgedbooleanNo——
workflow_statestringNo——
delivery_time_secondsfloatNo——
parent_workflow_uuidstringNo——
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
ackingYesNo—ack—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
ackingackcompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "hook.acknowledge-event",
  "initial_data": {
    "redirect_uuid": "value",
    "event_uuid": "value",
    "local_status_code": 123
  }
}