Triggers

Every workflow has one trigger, and any workflow can also be run manually. Schedules and webhooks fire only while enabled is true, and they require a paid plan: on Free, enabling one returns 403 plan_limit with limit.kind: "api".

Inputs

trigger.inputs declares what a run takes, at most 20 inputs. Templates read them as {{trigger.key}}:

{
  "type": "manual",
  "inputs": [
    {
      "key": "status",
      "label": "Invoice status",
      "type": "string",
      "required": false,
      "default": "open",
      "description": ""
    }
  ]
}

key uses lowercase letters, digits and _. type is string, number or boolean. label defaults to the key. A run's input is validated against these and defaults are filled in. Webhook body fields that are not declared are passed through unchanged.

Schedules

{
  "type": "schedule",
  "inputs": [],
  "schedule": {
    "frequency": "weekdays",
    "at": "09:00",
    "timezone": "Europe/Berlin",
    "input": {}
  }
}

every is optional. A monthly schedule's day is 1 to 31, or -1 for the last day of the month (default 1). A month without that day runs on its last day, so 31 runs on 30 April and on 28 or 29 February. at is HH:MM in timezone, an IANA name such as Europe/Berlin (default UTC). Weekdays and times follow the local clock in timezone across daylight saving changes: a time the clock skips runs an hour later, and a time that occurs twice runs the first time. With every above 1, the schedule counts from its first run. input is the input each scheduled run receives. While the workflow is enabled, next_run_at gives the next scheduled time.

Webhook triggers

A workflow with "type": "webhook" gets a webhook_url when it is saved. Another service starts a run by POSTing JSON to it; the body is the run's input.

curl https://api.fous.com/v1/hooks/whk_3q9ZxK0cLm2vT8yR5nB1wJ7dF4hG6sPa \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1042" \
  -d '{ "order_id": 1042, "customer": { "name": "Ada" } }'

Returns 202 with the run's ID:

{ "run_id": "wfr_01m6vhg04gfg9983c4agtcvyse", "workflow_id": "wf_01m6vnc9ewe3za9g5kqvd8yrkp" }

The URL takes no API key, so keep it secret. If it leaks, replace it with POST /v1/workflows/{id}/webhook; the old URL stops working immediately.