Skip to content
Proud to collaborate with Microsoft for Startups

hook.poll-events ​

Pick up pending webhook events for a redirect (DevKit poll)

Pick up pending webhook events for a redirect on behalf of DevKit.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-hookredirect
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
redirect_uuiduuidYes—UUID of the WebhookRedirect to poll
limitintegerNo—Maximum number of events to pick up (default 10, max 100)
offsetintegerNo—Number of pending events to skip (default 0)
devkit_client_refstringNo—Identifier of the polling DevKit client (for audit)

Output Schema ​

FieldTypeRequiredDefaultDescription
limitintegerNo——
offsetintegerNo——
devkit_client_refstringNo——
eventslistNo—Picked-up events (UUID-only surface)
totalintegerNo—Total pending events before this poll
picked_up_countintegerNo—Number of events transitioned to PICKED_UP
forward_urlstringNo—Forward URL configured on the redirect, if any
redirect_uuidstringNo—Echo of the polled redirect uuid
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
pollingYesNo—poll—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pollingpollcompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "hook.poll-events",
  "initial_data": {
    "redirect_uuid": "value"
  }
}