Webhooks

Start workflows from events and receive events when executions change state.

Demonstration example. FLOWTYPE ORCHESTRATE does not expose a live API yet, and the values below are placeholders.

Create a webhook

Register an HTTPS endpoint and choose which events it should receive.

POST /v1/webhooks
Authorization: Bearer YOUR_API_KEY

{
  "url": "https://example.com/flowtype/events",
  "events": ["execution.completed", "execution.failed"]
}

Receive an event

FLOWTYPE would send an HTTP POST with a JSON body to your endpoint. Respond with a 2xx status to acknowledge it.

{
  "event": "execution.completed",
  "execution_id": "demo_48291",
  "workflow": "customer-onboarding",
  "status": "success"
}

Verify the signature

Each delivery is intended to include a signature header computed with a secret only you and FLOWTYPE know. Verify it before trusting the payload.

Trigger a workflow

A workflow with a webhook trigger gets its own inbound URL. Any system that can send an HTTP POST can start it.

POST /v1/hooks/customer-onboarding
X-Flowtype-Signature: DEMO_SIGNATURE

{ "customer": "Northwind Traders" }

Inspect the execution

Use the execution ID from the event to read the run, including every step’s input, output and duration.

GET /v1/executions/demo_48291

Delivery and retries

Failed deliveries are intended to be retried with backoff for a limited period. Delivery attempts would be visible in the workspace.