Automations

Create automation

Create a Famulor automation from a definition, activate it, and prove it with a real test run.

Docs

post/user/automate/flows

Request

  • Base URL: https://app.famulor.de/api
  • URL: https://app.famulor.de/api/user/automate/flows
  • Auth: HTTP bearer

Request body

namestring required

A short human name for the automation (max 255 characters)

flowobject required

The automation definition — {"trigger": {...}, "steps": [...]} as described above. Max 1 MB.

sampleobject

A realistically-shaped sample payload for the test run (what the trigger will receive). For assistant events, a canonical sample built from the assistant’s own variables is used when omitted. Max 256 KB.

assistant_idinteger

Required for assistant-event automations (phoneCallEnded, inboundCall, newConversation, and bind_webhook): the assistant this automation attaches to. It starts receiving that assistant’s real events after the test passes. (For the platform triggers, selecting the assistant inside the trigger’s settings.input.assistant also works — the explicit parameter wins.)

bind_webhookstring

For a webhook-triggered definition only: attach it to the assistant’s conversation-ended event. The only supported value is conversation_ended. Requires assistant_id.

confirm_side_effectsboolean

Required (true) when the definition contains steps that send messages or emails, start calls, or make non-GET HTTP requests — the test run executes them for real.

Response

Created

automation_idstring

The ID of the created automation

webhook_urlstring nullable

For webhook-triggered automations (including conversation-ended ones): the URL external systems call to fire it. null for assistant-event and schedule automations.

statusstring

active — the test run passed; the automation is live (and attached, for assistant events). active_untested — the trigger cannot be fired on demand (schedules, external integrations); the automation is live and armed, and the first real event is the proof. test_failed — the test run failed; the automation was left disabled. Read test.steps for the per-step classification.

bindingobject nullable

For assistant-event automations: {"type": "post_call" | "inbound" | "conversation" | "conversation_ended", "assistant_id": <id>, "bound": <bool>}. bound is true only after a green test.

Changes

No recorded changes to this operation across all 1 revision of this API.