How do you start a FlowSharp process from an external system?

Starting a FlowSharp process from an external system is done via API trigger: an HTTP POST call to the flow's dedicated endpoint, authenticated with an API key.

Call pattern:

POST /api/flows/{flow-id}/trigger
Authorization: Bearer {api-key}
Content-Type: application/json

{
  "data": {
    "client": "ACME Ltd",
    "amount": 15000,
    "source": "e-commerce"
  }
}

The response includes the created item's ID and its initial state.

Typical trigger sources:

• E-commerce — a confirmed order starts the Order to Cash flow
• CRM — a qualified lead starts the onboarding flow
• Customer portal — a support request starts the complaint handling flow
• ERP — a received invoice starts the payment approval flow
• n8n or Zapier — any event in any automation tool can start a FlowSharp flow

Security:

• Each API key is associated with a specific site/system and can be revoked independently
• Data passed in the trigger is validated against the flow schema before creating the item
• The trigger origin is tracked in the item timeline

Configuration:

1. Create an API key in FlowSharp (Admin → Integrations)
2. Copy the specific flow's trigger endpoint
3. Configure the external system with the key and endpoint
4. Test with a trial call and verify the created item