{ "message": "This automation contains steps that would REALLY send messages, emails or start calls during the test run: Send SMS. Confirm with the user first — point those steps at a safe recipient the user owns — then retry with confirm_side_effects set to true.", "error": "side_effects_require_confirmation"}
Automations
Create automation
Create a Famulor automation from a definition, activate it, and prove it with a real test run.
{ "message": "This automation contains steps that would REALLY send messages, emails or start calls during the test run: Send SMS. Confirm with the user first — point those steps at a safe recipient the user owns — then retry with confirm_side_effects set to true.", "error": "side_effects_require_confirmation"}
Famulor 1.0 API (legacy). This page applies only to Famulor 1.0 (app.famulor.de) and is retained for legacy compatibility. For the current platform, use the Famulor 2.0 API reference.
This endpoint creates an automation from its definition (a trigger and its chained steps), activates it, executes a real test run with your sample payload, and reports the result step by step. The test run is the gate: an automation whose test fails is left disabled, and an assistant-event automation is only attached to the assistant after its test passes.When a ready-made template matches what you need, applying it is simpler than writing a definition from scratch.
The test run executes the automation for real. Definitions containing steps that send messages or emails, or start calls, are refused unless you explicitly pass confirm_side_effects: true — and when you do, those steps really send during the test. Point them at recipients you own.
The steps are chained onto the trigger in the order given. The only nesting you write yourself is inside a step that needs it — a BRANCH step’s conditional steps go under its onSuccessAction / onFailureAction. (A hand-nested tree, where each step sits under the previous one’s nextAction, is also accepted.)A definition always replaces the whole automation — it is never merged. A trigger with no steps is rejected (no_steps): an automation that does nothing cannot be activated.
You get a webhook_url to call from external systems. The payload arrives wrapped: reference fields as {{trigger['body']['field']}}. Tested synchronously with your sample.
Phone call ended
@famulor/piece-famulor / phoneCallEnded
Requires assistant_id. Attached to the assistant after a green test. Payload fields live directly on the trigger: {{trigger['extracted_variables']['x']}}, {{trigger['customer_phone']}}, …
Inbound call
@famulor/piece-famulor / inboundCall
Requires assistant_id. Runs before the assistant answers; must end in a respond step returning a flat map of strings.
Cannot be fired on demand — activates armed as active_untested; the first scheduled run is the proof (check runs).
External integrations
the integration’s own trigger (new spreadsheet row, new CRM contact, new lead, …)
Your connected account is attached automatically; if it is missing or expired you get a needs_connection / needs_reconnection error with the exact steps to fix it in the Famulor app. Activates as active_untested.
Steps reference earlier output by step name — {{step_1['body']['field']}} for HTTP steps (their JSON nests under body). Common step shapes: HTTP requests, code transforms, branches, delays, respond steps, and Famulor platform actions (send SMS/WhatsApp, start a call, re-queue a lead). The easiest way to learn a step’s exact shape is to read an existing automation with Get automation or apply a template and inspect what it built.
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.
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.)
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.
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.
Returns 201 when the automation is active (active / active_untested), 200 when it was built but its test run failed (test_failed), and 422 for a definition that never reached the test run (see error codes below).
For webhook-triggered automations (including conversation-ended ones): the URL external systems call to fire it. null for assistant-event and schedule automations.
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.
SUCCEEDED, PAUSED, FAILED, or not_tested (untestable triggers); rarely no_run when the test produced no execution record. PAUSED counts as success: the run is parked at a Delay step waiting for its target time — every step before the delay already ran.
ok, paused_at_delay, or — for failures — wiring_error (the definition is wrong: fix it and repair via Update automation), missing_connection (an account must be connected in the Famulor app first), missing_record (the sample referenced data that does not exist — often fine).
For assistant-event automations: {"type": "post_call" | "inbound" | "conversation" | "conversation_ended", "assistant_id": <id>, "bound": <bool>}. bound is true only after a green test.
Hard failures return {"message": "...", "error": "<code>"} and nothing is activated. Notable codes:
error
Meaning
side_effects_require_confirmation
The definition contains steps that would really send during the test — retry with confirm_side_effects: true after checking the recipients.
no_steps
The trigger has no steps chained to it.
invalid_definition / unsupported_trigger
The definition is missing its trigger, or uses a trigger type that is not supported.
assistant_required / assistant_not_found
The trigger needs an assistant_id, or the assistant does not belong to your account.
binding_conflict
The assistant already has an automation (or a custom webhook) for this event — an assistant has one slot per event type. Update the existing automation instead, or delete it first.
needs_connection / needs_reconnection
The trigger’s integration account must be connected (or reconnected) in the Famulor app first — the message contains the exact steps.
import_failed / publish_failed / create_failed
The definition was rejected or could not be activated.
{ "message": "This automation contains steps that would REALLY send messages, emails or start calls during the test run: Send SMS. Confirm with the user first — point those steps at a safe recipient the user owns — then retry with confirm_side_effects set to true.", "error": "side_effects_require_confirmation"}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Famulor","description":"Famulor documentation — build, deploy, and operate AI voice assistants.","colors":{"primary":"#1FD5FA","light":"#67E8FC","dark":"#0BA8C9"},"logo":{"light":"https://mintcdn.com/ouraicall/baoJp-MLrp4Nh8VX/logo/lockup-light.svg?fit=max\u0026auto=format\u0026n=baoJp-MLrp4Nh8VX\u0026q=85\u0026s=fd2b4cadd4821a549ba9fa5783ed619d","dark":"https://mintcdn.com/ouraicall/baoJp-MLrp4Nh8VX/logo/lockup-dark.svg?fit=max\u0026auto=format\u0026n=baoJp-MLrp4Nh8VX\u0026q=85\u0026s=8c5966ded7ffff8de6db3a09bd55f712"},"favicon":"https://mintcdn.com/ouraicall/2UgcT6Kzg4NlgPC2/favicon.svg?fit=max\u0026auto=format\u0026n=2UgcT6Kzg4NlgPC2\u0026q=85\u0026s=b7b1116d604f04ce5ebedef057e0580f","navbar":{"links":[{"href":"https://status.famulor.io","label":"Platform Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.famulor.io"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/Famulor"}},"seo":{"metatags":{"twitter:card":"summary_large_image"},"organization":{"name":"Famulor","logo":"https://docs.famulor.io/logo/lockup-light.svg"}},"integrations":{"clarity":{"projectId":"sop2kcwotx"},"ga4":{"measurementId":"G-WPTBT13HB0"}},"banner":{"content":"For AI agents: see the complete **[llms.txt](https://docs.famulor.io/llms.txt)** documentation index.","dismissible":true,"color":{"light":"#000000","dark":"#000000"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"fr","href":"fr"},{"language":"es","href":"es"},{"language":"de","href":"de"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ouraicall","hasAudioNarration":false,"actualSubdomain":"ouraicall","customDomains":["docs.famulor.io"],"gitSource":{"type":"github","owner":"bekservice","repo":"famulor-multi-tenancy","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"837052af-37d0-49a0-b690-4af7a4b0dde2","liveDeploymentHistoryId":"6addaf84aa71df2f0249f4d9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6addaf84aa71df2f0249f4d9"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6addaf84aa71df2f0249f4d9","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":425},{"language":"en","tag":"Documentation","count":132},{"language":"de","tag":"Dokumentation","count":132},{"language":"es","tag":"Documentación","count":132},{"language":"fr","tag":"Documentation","count":132},{"language":"en","tag":"API 1.0 (Legacy)","count":102},{"language":"de","tag":"API 1.0 (Legacy)","count":102},{"language":"es","tag":"API 1.0 (Legacy)","count":102},{"language":"fr","tag":"API 1.0 (Legacy)","count":102},{"language":"default","tag":"Famulor Loop","count":37},{"language":"en","tag":"API Reference","count":35},{"language":"en","tag":"Assistants","count":35},{"language":"default","tag":"Messaging","count":35},{"language":"de","tag":"Assistenten","count":35},{"language":"es","tag":"Asistentes","count":35},{"language":"fr","tag":"Assistants","count":35},{"language":"en","tag":"Channels","count":32},{"language":"de","tag":"API-Referenz","count":32},{"language":"de","tag":"Kanäle","count":32},{"language":"es","tag":"Canales","count":32},{"language":"fr","tag":"Canaux","count":32},{"language":"default","tag":"Knowledge Bases","count":31},{"language":"default","tag":"Automations","count":28},{"language":"en","tag":"Automation","count":27},{"language":"default","tag":"Settings","count":27},{"language":"de","tag":"Automatisierung","count":27},{"language":"es","tag":"Automatización","count":27},{"language":"es","tag":"Referencia de la API","count":27},{"language":"fr","tag":"Automatisation","count":27},{"language":"fr","tag":"Référence API","count":27},{"language":"en","tag":"Telephony","count":25},{"language":"de","tag":"Telefonie","count":25},{"language":"es","tag":"Telefonía","count":25},{"language":"fr","tag":"Téléphonie","count":25},{"language":"en","tag":"AI Assistants","count":24},{"language":"de","tag":"KI-Assistants","count":24},{"language":"es","tag":"Asistentes de IA","count":24},{"language":"fr","tag":"Assistants IA","count":24},{"language":"default","tag":"Assistants","count":20},{"language":"default","tag":"White Label","count":20},{"language":"default","tag":"Tools","count":18},{"language":"en","tag":"Shopify","count":16},{"language":"default","tag":"Integrations","count":16},{"language":"de","tag":"Shopify","count":16},{"language":"es","tag":"Shopify","count":16},{"language":"fr","tag":"Shopify","count":16},{"language":"en","tag":"Getting started","count":11},{"language":"de","tag":"Erste Schritte","count":11},{"language":"es","tag":"Primeros pasos","count":11},{"language":"fr","tag":"Bien démarrer","count":11}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-v1/automations/create","slug":"/api-v1/automations/create","pageMetadata":{"title":"Create automation","api":"POST https://app.famulor.de/api/user/automate/flows","description":"Create a Famulor automation from a definition, activate it, and prove it with a real test run.","href":"/api-v1/automations/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a Famulor automation from a definition, activate it, and prove it with a real test run.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField,Table,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Famulor 1.0 API (legacy).`}),` This page applies only to Famulor 1.0 (`,_jsx(_components.code,{children:`app.famulor.de`}),`) and is retained for legacy compatibility. For the current platform, use the `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`Famulor 2.0 API reference`}),`.`]})}),`\n`,_jsx(_components.p,{children:`This endpoint creates an automation from its definition (a trigger and its chained steps), activates it, executes a real test run with your sample payload, and reports the result step by step. The test run is the gate: an automation whose test fails is left disabled, and an assistant-event automation is only attached to the assistant after its test passes.`}),`\n`,_jsxs(_components.p,{children:[`When a ready-made template matches what you need, `,_jsx(_components.a,{href:`/api-v1/automations/apply-template`,children:`applying it`}),` is simpler than writing a definition from scratch.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The test run executes the automation for real. Definitions containing steps that send messages or emails, or start calls, are refused unless you explicitly pass `,_jsx(_components.code,{children:`confirm_side_effects: true`}),` — and when you do, those steps really send during the test. Point them at recipients you own.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`the-definition-format`,children:`The definition format`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`flow`}),` object is the automation’s definition. The preferred shape is a flat list:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"trigger\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"steps\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [ `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`step`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`step`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The steps are chained onto the trigger in the order given. The only nesting you write yourself is inside a step that needs it — a `,_jsx(_components.code,{children:`BRANCH`}),` step’s conditional steps go under its `,_jsx(_components.code,{children:`onSuccessAction`}),` / `,_jsx(_components.code,{children:`onFailureAction`}),`. (A hand-nested tree, where each step sits under the previous one’s `,_jsx(_components.code,{children:`nextAction`}),`, is also accepted.)`]}),`\n`,_jsxs(_components.p,{children:[`A definition always replaces the whole automation — it is never merged. A trigger with no steps is rejected (`,_jsx(_components.code,{children:`no_steps`}),`): an automation that does nothing cannot be activated.`]}),`\n`,_jsxs(Heading,{level:`4`,id:`supported-triggers-trigger-settings`,children:[`Supported triggers (`,_jsx(_components.code,{children:`trigger.settings`}),`)`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Trigger`}),_jsx(_components.th,{children:`pieceName / triggerName`}),_jsx(_components.th,{children:`Behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Webhook`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`@activepieces/piece-webhook`}),` / `,_jsx(_components.code,{children:`catch_webhook`})]}),_jsxs(_components.td,{children:[`You get a `,_jsx(_components.code,{children:`webhook_url`}),` to call from external systems. The payload arrives wrapped: reference fields as `,_jsx(_components.code,{children:`{{trigger['body']['field']}}`}),`. Tested synchronously with your sample.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Phone call ended`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`@famulor/piece-famulor`}),` / `,_jsx(_components.code,{children:`phoneCallEnded`})]}),_jsxs(_components.td,{children:[`Requires `,_jsx(_components.code,{children:`assistant_id`}),`. Attached to the assistant after a green test. Payload fields live directly on the trigger: `,_jsx(_components.code,{children:`{{trigger['extracted_variables']['x']}}`}),`, `,_jsx(_components.code,{children:`{{trigger['customer_phone']}}`}),`, …`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Inbound call`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`@famulor/piece-famulor`}),` / `,_jsx(_components.code,{children:`inboundCall`})]}),_jsxs(_components.td,{children:[`Requires `,_jsx(_components.code,{children:`assistant_id`}),`. Runs before the assistant answers; must end in a respond step returning a flat map of strings.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`New conversation`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`@famulor/piece-famulor`}),` / `,_jsx(_components.code,{children:`newConversation`})]}),_jsxs(_components.td,{children:[`Requires `,_jsx(_components.code,{children:`assistant_id`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Conversation ended`}),_jsxs(_components.td,{children:[`webhook trigger + `,_jsx(_components.code,{children:`bind_webhook: \"conversation_ended\"`})]}),_jsxs(_components.td,{children:[`Requires `,_jsx(_components.code,{children:`assistant_id`}),`. Fires when a chat ends; payload arrives wrapped, so reference fields through `,_jsx(_components.code,{children:`{{trigger['body']['...']}}`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Schedule`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`@activepieces/piece-schedule`}),` / `,_jsx(_components.code,{children:`every_x_minutes`}),`, `,_jsx(_components.code,{children:`every_day`}),`, …`]}),_jsxs(_components.td,{children:[`Cannot be fired on demand — activates armed as `,_jsx(_components.code,{children:`active_untested`}),`; the first scheduled run is the proof (check runs).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`External integrations`}),_jsx(_components.td,{children:`the integration’s own trigger (new spreadsheet row, new CRM contact, new lead, …)`}),_jsxs(_components.td,{children:[`Your connected account is attached automatically; if it is missing or expired you get a `,_jsx(_components.code,{children:`needs_connection`}),` / `,_jsx(_components.code,{children:`needs_reconnection`}),` error with the exact steps to fix it in the Famulor app. Activates as `,_jsx(_components.code,{children:`active_untested`}),`.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Steps reference earlier output by step name — `,_jsx(_components.code,{children:`{{step_1['body']['field']}}`}),` for HTTP steps (their JSON nests under `,_jsx(_components.code,{children:`body`}),`). Common step shapes: HTTP requests, code transforms, branches, delays, respond steps, and Famulor platform actions (send SMS/WhatsApp, start a call, re-queue a lead). The easiest way to learn a step’s exact shape is to read an existing automation with `,_jsx(_components.a,{href:`/api-v1/automations/get`,children:`Get automation`}),` or apply a template and inspect what it built.`]}),`\n`,_jsx(Heading,{level:`3`,id:`request-body`,children:`Request body`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`A short human name for the automation (max 255 characters)`})}),`\n`,_jsx(ParamField,{body:`flow`,type:`object`,required:true,id:`param-flow`,children:_jsxs(_components.p,{children:[`The automation definition — `,_jsx(_components.code,{children:`{\"trigger\": {...}, \"steps\": [...]}`}),` as described above. Max 1 MB.`]})}),`\n`,_jsx(ParamField,{body:`sample`,type:`object`,id:`param-sample`,children:_jsx(_components.p,{children:`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.`})}),`\n`,_jsx(ParamField,{body:`assistant_id`,type:`integer`,id:`param-assistant-id`,children:_jsxs(_components.p,{children:[`Required for assistant-event automations (`,_jsx(_components.code,{children:`phoneCallEnded`}),`, `,_jsx(_components.code,{children:`inboundCall`}),`, `,_jsx(_components.code,{children:`newConversation`}),`, and `,_jsx(_components.code,{children:`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 `,_jsx(_components.code,{children:`settings.input.assistant`}),` also works — the explicit parameter wins.)`]})}),`\n`,_jsx(ParamField,{body:`bind_webhook`,type:`string`,id:`param-bind-webhook`,children:_jsxs(_components.p,{children:[`For a webhook-triggered definition only: attach it to the assistant’s conversation-ended event. The only supported value is `,_jsx(_components.code,{children:`conversation_ended`}),`. Requires `,_jsx(_components.code,{children:`assistant_id`}),`.`]})}),`\n`,_jsx(ParamField,{body:`confirm_side_effects`,type:`boolean`,id:`param-confirm-side-effects`,children:_jsxs(_components.p,{children:[`Required (`,_jsx(_components.code,{children:`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.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`201`}),` when the automation is active (`,_jsx(_components.code,{children:`active`}),` / `,_jsx(_components.code,{children:`active_untested`}),`), `,_jsx(_components.code,{children:`200`}),` when it was built but its test run failed (`,_jsx(_components.code,{children:`test_failed`}),`), and `,_jsx(_components.code,{children:`422`}),` for a definition that never reached the test run (see error codes below).`]}),`\n`,_jsx(ResponseField,{name:`automation_id`,type:`string`,id:`param-automation-id`,children:_jsx(_components.p,{children:`The ID of the created automation`})}),`\n`,_jsx(ResponseField,{name:`webhook_url`,type:`string | null`,id:`param-webhook-url`,children:_jsxs(_components.p,{children:[`For webhook-triggered automations (including conversation-ended ones): the URL external systems call to fire it. `,_jsx(_components.code,{children:`null`}),` for assistant-event and schedule automations.`]})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`active`}),` — the test run passed; the automation is live (and attached, for assistant events).\n`,_jsx(_components.code,{children:`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.\n`,_jsx(_components.code,{children:`test_failed`}),` — the test run failed; the automation was left disabled. Read `,_jsx(_components.code,{children:`test.steps`}),` for the per-step classification.`]})}),`\n`,_jsxs(ResponseField,{name:`test`,type:`object`,id:`param-test`,children:[_jsx(_components.p,{children:`The test run result`}),_jsxs(Expandable,{title:`test properties`,children:[_jsx(ResponseField,{name:`run_status`,type:`string`,id:`param-run-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`SUCCEEDED`}),`, `,_jsx(_components.code,{children:`PAUSED`}),`, `,_jsx(_components.code,{children:`FAILED`}),`, or `,_jsx(_components.code,{children:`not_tested`}),` (untestable triggers); rarely `,_jsx(_components.code,{children:`no_run`}),` when the test produced no execution record. `,_jsx(_components.code,{children:`PAUSED`}),` counts as success: the run is parked at a Delay step waiting for its target time — every step before the delay already ran.`]})}),_jsxs(ResponseField,{name:`steps`,type:`array`,id:`param-steps`,children:[_jsx(_components.p,{children:`Per-step outcome of the test run`}),_jsxs(Expandable,{title:`step properties`,children:[_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:_jsxs(_components.p,{children:[`The step name (`,_jsx(_components.code,{children:`trigger`}),`, `,_jsx(_components.code,{children:`step_1`}),`, …)`]})}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`SUCCEEDED`}),`, `,_jsx(_components.code,{children:`FAILED`}),` or `,_jsx(_components.code,{children:`PAUSED`})]})}),_jsx(ResponseField,{name:`classification`,type:`string`,id:`param-classification`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`ok`}),`, `,_jsx(_components.code,{children:`paused_at_delay`}),`, or — for failures — `,_jsx(_components.code,{children:`wiring_error`}),` (the definition is wrong: fix it and repair via `,_jsx(_components.a,{href:`/api-v1/automations/update`,children:`Update automation`}),`), `,_jsx(_components.code,{children:`missing_connection`}),` (an account must be connected in the Famulor app first), `,_jsx(_components.code,{children:`missing_record`}),` (the sample referenced data that does not exist — often fine).`]})}),_jsx(ResponseField,{name:`error`,type:`string | null`,id:`param-error`,children:_jsx(_components.p,{children:`The step’s error message, when it failed`})})]})]})]})]}),`\n`,_jsx(ResponseField,{name:`response`,type:`object | string | null`,id:`param-response`,children:_jsx(_components.p,{children:`For synchronously-tested automations (webhook and inbound triggers): what the automation responded during the test run`})}),`\n`,_jsx(ResponseField,{name:`binding`,type:`object | null`,id:`param-binding`,children:_jsxs(_components.p,{children:[`For assistant-event automations: `,_jsx(_components.code,{children:`{\"type\": \"post_call\" | \"inbound\" | \"conversation\" | \"conversation_ended\", \"assistant_id\": \u003cid>, \"bound\": \u003cbool>}`}),`. `,_jsx(_components.code,{children:`bound`}),` is `,_jsx(_components.code,{children:`true`}),` only after a green test.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`error-codes-422`,children:`Error codes (422)`}),`\n`,_jsxs(_components.p,{children:[`Hard failures return `,_jsx(_components.code,{children:`{\"message\": \"...\", \"error\": \"\u003ccode>\"}`}),` and nothing is activated. Notable codes:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`error`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`side_effects_require_confirmation`})}),_jsxs(_components.td,{children:[`The definition contains steps that would really send during the test — retry with `,_jsx(_components.code,{children:`confirm_side_effects: true`}),` after checking the recipients.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`no_steps`})}),_jsx(_components.td,{children:`The trigger has no steps chained to it.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`invalid_definition`}),` / `,_jsx(_components.code,{children:`unsupported_trigger`})]}),_jsx(_components.td,{children:`The definition is missing its trigger, or uses a trigger type that is not supported.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`assistant_required`}),` / `,_jsx(_components.code,{children:`assistant_not_found`})]}),_jsxs(_components.td,{children:[`The trigger needs an `,_jsx(_components.code,{children:`assistant_id`}),`, or the assistant does not belong to your account.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`binding_conflict`})}),_jsx(_components.td,{children:`The assistant already has an automation (or a custom webhook) for this event — an assistant has one slot per event type. Update the existing automation instead, or delete it first.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`needs_connection`}),` / `,_jsx(_components.code,{children:`needs_reconnection`})]}),_jsx(_components.td,{children:`The trigger’s integration account must be connected (or reconnected) in the Famulor app first — the message contains the exact steps.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`import_failed`}),` / `,_jsx(_components.code,{children:`publish_failed`}),` / `,_jsx(_components.code,{children:`create_failed`})]}),_jsx(_components.td,{children:`The definition was rejected or could not be activated.`})]})]})]}),`\n`,`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Related pages: `,_jsx(_components.a,{href:`/api-v1/automations/list-templates`,children:`List automation templates`}),`, `,_jsx(_components.a,{href:`/api-v1/automations/apply-template`,children:`Apply automation template`}),`, and `,_jsx(_components.a,{href:`/api-v1/authentication`,children:`Authentication`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create automation","api":"POST https://app.famulor.de/api/user/automate/flows","description":"Create a Famulor automation from a definition, activate it, and prove it with a real test run.","href":"/api-v1/automations/create"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[389,393,"Example,ResponseFiel"],[650,665,"Example)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingM"],[19672,20474,"_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`201 Created (webhook, test passed)`,numberOfLines:`14`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"automation_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"f4EaLhOW2zoEsXXSOJP2r\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"webhook_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://automate.famulor.ai/api/v1/webhooks/f4EaLhOW2zoEsXXSOJP2r\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"test\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"run_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SUCCEEDED\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"steps\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"trigger\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SUCCEEDED\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"classification\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"step_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SUCCEEDED\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"classification\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"response\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"true\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"echo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"hello\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"binding\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`201 Created (schedule, active_untested)`,numberOfLines:`11`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`11`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"automation_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"aB3xYz01MnOpQrStUvWxY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"webhook_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active_untested\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"test\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"run_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"not_tested\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"steps\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: []`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"response\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"binding\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`422 Validation Error`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"This automation contains steps that would REALLY send messages, emails or start calls during the test run: Send SMS. Confirm with the user first — point those steps at a safe recipient the user owns — then retry with confirm_side_effects set to true.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"side_effects_require_confirmation\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Related pages: `,_jsx(_components.a,{href:`/api-v1/automations/list-templates`,children:`List automation templates`}),`, `,_jsx(_components.a,{href:`/api-v1/automations/apply-template`,children:`Apply automation template`}),`, and `,_jsx(_components.a,{href:`/api-v1/authentication`,children:`Authentication`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}"]]},"mdxExtracts":{"tableOfContents":[{"title":"The definition format","slug":"the-definition-format","depth":3,"children":[]},{"title":"Supported triggers (trigger.settings)","slug":"supported-triggers-trigger-settings","depth":4,"children":[]},{"title":"Request body","slug":"request-body","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Error codes (422)","slug":"error-codes-422","depth":3,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"201 Created (webhook, test passed)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"14\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"automation_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"f4EaLhOW2zoEsXXSOJP2r\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"webhook_url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://automate.famulor.ai/api/v1/webhooks/f4EaLhOW2zoEsXXSOJP2r\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"active\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"test\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"run_status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"SUCCEEDED\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"steps\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"trigger\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"SUCCEEDED\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"classification\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ok\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"step_1\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"SUCCEEDED\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"classification\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ok\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"response\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"ok\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"true\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"echo\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"hello\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"binding\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"201 Created (schedule, active_untested)","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"11\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"automation_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"aB3xYz01MnOpQrStUvWxY\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"webhook_url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"active_untested\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"test\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"run_status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"not_tested\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"steps\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: []\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"response\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"binding\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"422 Validation Error","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"This automation contains steps that would REALLY send messages, emails or start calls during the test run: Send SMS. Confirm with the user first — point those steps at a safe recipient the user owns — then retry with confirm_side_effects set to true.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"side_effects_require_confirmation\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create automation","path":"/api/user/automate/flows","servers":[{"url":"https://app.famulor.de"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"name":[{"type":"string","description":"A short human name for the automation (max 255 characters)","required":true}],"flow":[{"type":"object","properties":{},"description":"The automation definition — `{\"trigger\": {...}, \"steps\": [...]}` as described above. Max 1 MB.","required":true}],"sample":[{"type":"object","properties":{},"description":"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_id":[{"type":"integer","description":"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_webhook":[{"type":"string","description":"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_effects":[{"type":"boolean","description":"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."}]}}],"examples":{"example":{"value":{"name":"\u003cstring>","flow":{},"sample":{},"assistant_id":123,"bind_webhook":"\u003cstring>","confirm_side_effects":true}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"automation_id":[{"type":"string","description":"The ID of the created automation"}],"webhook_url":[{"type":"object","properties":{},"description":"For webhook-triggered automations (including conversation-ended ones): the URL external systems call to fire it. `null` for assistant-event and schedule automations."}],"status":[{"type":"string","description":"`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."}],"test":[{"type":"object","properties":{"run_status":[{"type":"string","description":"`SUCCEEDED` , `PAUSED` , `FAILED` , or `not_tested` (untestable triggers); rarely `no_run` when the test produced no execution record. `PAUSED` counts as success: the run is parked at a Delay step waiting for its target time — every step before the delay already ran."}],"steps":[{"type":"array","items":[{"type":"object","properties":{"name":[{"type":"string","description":"The step name ( `trigger` , `step_1` , …)"}],"status":[{"type":"string","description":"`SUCCEEDED` , `FAILED` or `PAUSED`"}],"classification":[{"type":"string","description":"`ok` , `paused_at_delay` , or — for failures — `wiring_error` (the definition is wrong: fix it and repair via Update automation ), `missing_connection` (an account must be connected in the Famulor app first), `missing_record` (the sample referenced data that does not exist — often fine)."}],"error":[{"type":"object","properties":{},"description":"The step’s error message, when it failed"}]}}],"description":"Per-step outcome of the test run"}]},"description":"The test run result"}],"response":[{"type":"object","properties":{},"description":"For synchronously-tested automations (webhook and inbound triggers): what the automation responded during the test run"}],"binding":[{"type":"object","properties":{},"description":"For assistant-event automations: `{\"type\": \"post_call\" | \"inbound\" | \"conversation\" | \"conversation_ended\", \"assistant_id\": \u003cid>, \"bound\": \u003cbool>}` . `bound` is `true` only after a green test."}]}}],"examples":{"example":{"value":{"automation_id":"\u003cstring>","webhook_url":{},"status":"\u003cstring>","test":{"run_status":"\u003cstring>","steps":[{"name":"\u003cstring>","status":"\u003cstring>","classification":"\u003cstring>","error":{}}]},"response":{},"binding":{}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"ouraicall","siteName":"Famulor","title":"Create automation - Famulor","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-v1/automations/create","matchLevel":0},"fr":{"href":"/fr/api-v1/automations/create","matchLevel":1},"es":{"href":"/es/api-v1/automations/create","matchLevel":1},"de":{"href":"/de/api-v1/automations/create","matchLevel":1}}},"lastModified":"2026-08-26T22:30:42.898Z","originalFileLocation":"api-v1/automations/create.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a Famulor automation from a definition, activate it, and prove it with a real test run.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Famulor\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create automation - Famulor\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a Famulor automation from a definition, activate it, and prove it with a real test run.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Famulor\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.famulor.io/api-v1/automations/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ouraicall.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Create+automation\u0026amp;description=Create+a+Famulor+automation+from+a+definition%2C+activate+it%2C+and+prove+it+with+a+real+test+run.\u0026amp;theme=cc4516d305bac9e7bd8e915a\u0026amp;signature=ae21de40a8b7681022d373d34045fac1e5778800d34224bb95f2672ec984efeb\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create automation - Famulor\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a Famulor automation from a definition, activate it, and prove it with a real test run.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ouraicall.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Create+automation\u0026amp;description=Create+a+Famulor+automation+from+a+definition%2C+activate+it%2C+and+prove+it+with+a+real+test+run.\u0026amp;theme=cc4516d305bac9e7bd8e915a\u0026amp;signature=ae21de40a8b7681022d373d34045fac1e5778800d34224bb95f2672ec984efeb\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Famulor\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1FD5FA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.famulor.io/api-v1/automations/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-v1/automations/create.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.famulor.io/api-v1/automations/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.famulor.io/fr/api-v1/automations/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.famulor.io/es/api-v1/automations/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.famulor.io/de/api-v1/automations/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.famulor.io/api-v1/automations/create\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.famulor.io/#organization\",\"name\":\"Famulor\",\"url\":\"https://docs.famulor.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.famulor.io/logo/lockup-light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.famulor.io#website\",\"name\":\"Famulor\",\"url\":\"https://docs.famulor.io\",\"publisher\":{\"@id\":\"https://docs.famulor.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.famulor.io/api-v1/automations/create#webpage\",\"url\":\"https://docs.famulor.io/api-v1/automations/create\",\"name\":\"Create automation\",\"description\":\"Create a Famulor automation from a definition, activate it, and prove it with a real test run.\",\"dateModified\":\"2026-08-26T22:30:42.898Z\",\"isPartOf\":{\"@id\":\"https://docs.famulor.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.famulor.io/api-v1/automations/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.famulor.io/api-v1/automations/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Automations\",\"item\":\"https://docs.famulor.io/api-v1/automations/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create automation\",\"item\":\"https://docs.famulor.io/api-v1/automations/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.famulor.io/api-v1/automations/create#apireference\",\"headline\":\"Create automation\",\"name\":\"Create automation\",\"description\":\"Create a Famulor automation from a definition, activate it, and prove it with a real test run.\",\"url\":\"https://docs.famulor.io/api-v1/automations/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.famulor.io/api-v1/automations/create#webpage\"},\"dateModified\":\"2026-08-26T22:30:42.898Z\",\"publisher\":{\"@id\":\"https://docs.famulor.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.famulor.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Famulor\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Famulor","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Automation","pages":[{"title":"Automation","href":"/automations/overview"}]},{"tab":"White Label","pages":[{"title":"White Label","href":"/admin/tenants-and-whitelabel"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/overview"}]},{"tab":"API 1.0 (Legacy)","groups":[{"group":"API Reference","pages":[{"title":"Introduction","icon":"book-open","href":"/api-v1/introduction"},{"title":"Authentication","icon":"key","href":"/api-v1/authentication"},{"title":"Get User Information","api":"GET https://app.famulor.de/api/user/me","href":"/api-v1/user/me"}]},{"group":"AI Assistants","pages":[{"title":"Create Assistants","api":"POST https://app.famulor.de/api/user/assistant","href":"/api-v1/assistants/create"},{"title":"Delete Assistant","api":"DELETE https://app.famulor.de/api/user/assistant/{id}","href":"/api-v1/assistants/delete"},{"title":"Enable assistant inbound webhook","api":"POST /user/assistants/enable-inbound-webhook","href":"/api-v1/assistants/enable-inbound-webhook"},{"title":"Disable assistant inbound webhook","api":"POST /user/assistants/disable-inbound-webhook","href":"/api-v1/assistants/disable-inbound-webhook"},{"title":"Enable Conversation Ended Webhook","api":"POST https://app.famulor.de/api/user/assistants/enable-conversation-ended-webhook","href":"/api-v1/assistants/enable-conversation-ended-webhook"},{"title":"Disable conversation ended webhook","api":"POST https://app.famulor.de/api/user/assistants/disable-conversation-ended-webhook","href":"/api-v1/assistants/disable-conversation-ended-webhook"},{"title":"Disable assistant webhook","api":"POST /user/assistants/disable-webhook","href":"/api-v1/assistants/disable-webhook"},{"title":"Retrieve Available Languages","api":"GET https://app.famulor.de/api/user/assistants/languages","href":"/api-v1/assistants/languages"},{"title":"List Assistants","api":"GET https://app.famulor.de/api/user/assistants/get","href":"/api-v1/assistants/list"},{"title":"Assistant pictures","openapi":"GET /assistants/avatar-gallery","href":"/api-v1/assistants/avatar-gallery"},{"title":"Custom AI avatars — capability","openapi":"GET /avatars/capability","href":"/api-v1/avatars/capability"},{"title":"Custom AI avatars — uploads","openapi":"POST /avatars/uploads","href":"/api-v1/avatars/uploads"},{"title":"Custom AI avatars — submit","openapi":"POST /avatars","href":"/api-v1/avatars/submit"},{"title":"Custom AI avatars — list","openapi":"GET /avatars","href":"/api-v1/avatars/list"},{"title":"Custom AI avatars — get","openapi":"GET /avatars/{id}","href":"/api-v1/avatars/get"},{"title":"Custom AI avatars — delete","openapi":"DELETE /avatars/{id}","href":"/api-v1/avatars/delete"},{"title":"Custom AI avatars — catalog","openapi":"GET /avatars/catalog","href":"/api-v1/avatars/catalog"},{"title":"Retrieve Available Models","api":"GET https://app.famulor.de/api/user/assistants/models","href":"/api-v1/assistants/models"},{"title":"Get outbound assistants","api":"GET https://app.famulor.de/api/user/assistants/outbound","href":"/api-v1/assistants/outbound"},{"title":"Retrieve Available Phone Numbers","api":"GET https://app.famulor.de/api/user/assistants/phone-numbers","href":"/api-v1/assistants/phone-numbers"},{"title":"List synthesizer providers","api":"GET https://app.famulor.de/api/user/assistants/synthesizer-providers","href":"/api-v1/assistants/synthesizer-providers"},{"title":"List transcriber providers","api":"GET https://app.famulor.de/api/user/assistants/transcriber-providers","href":"/api-v1/assistants/transcriber-providers"},{"title":"Update Assistant","api":"PUT https://app.famulor.de/api/user/assistant/{id}","href":"/api-v1/assistants/update"},{"title":"Retrieve Available Voices","api":"GET https://app.famulor.de/api/user/assistants/voices","href":"/api-v1/assistants/voices"}]},{"group":"Folders","pages":[{"title":"List Folders","api":"GET https://app.famulor.de/api/user/folders","href":"/api-v1/folders/list"},{"title":"Create Folder","api":"POST https://app.famulor.de/api/user/folder","href":"/api-v1/folders/create"},{"title":"Update Folder","api":"PUT https://app.famulor.de/api/user/folder/{id}","href":"/api-v1/folders/update"},{"title":"Delete Folder","api":"DELETE https://app.famulor.de/api/user/folder/{id}","href":"/api-v1/folders/delete"}]},{"group":"Labels","pages":[{"title":"List Labels","api":"GET https://app.famulor.de/api/user/labels","href":"/api-v1/labels/list"},{"title":"Create Label","api":"POST https://app.famulor.de/api/user/label","href":"/api-v1/labels/create"},{"title":"Update Label","api":"PUT https://app.famulor.de/api/user/label/{id}","href":"/api-v1/labels/update"},{"title":"Delete Label","api":"DELETE https://app.famulor.de/api/user/label/{id}","href":"/api-v1/labels/delete"}]},{"group":"Leads","pages":[{"title":"List Leads","api":"GET https://app.famulor.de/api/user/leads","href":"/api-v1/leads/list"},{"title":"Create lead","api":"POST /user/lead","href":"/api-v1/leads/create"},{"title":"Update Lead","api":"PUT https://app.famulor.de/api/user/leads/{id}","href":"/api-v1/leads/update"},{"title":"Delete lead","api":"DELETE /user/leads/{id}","href":"/api-v1/leads/delete"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","api":"GET https://app.famulor.de/api/user/campaigns","href":"/api-v1/campaigns/list"},{"title":"Get campaign","api":"GET https://app.famulor.de/api/user/campaign/{id}","href":"/api-v1/campaigns/get"},{"title":"Create campaign","api":"POST https://app.famulor.de/api/user/campaign","href":"/api-v1/campaigns/create"},{"title":"External phone audiences (Beta)","openapi":"GET /campaigns/external-audience/connections","href":"/api-v1/campaigns/audience-connections"},{"title":"External phone audiences (Beta)","openapi":"GET /campaigns/external-audience/segments","href":"/api-v1/campaigns/audience-segments"},{"title":"External phone audiences (Beta)","openapi":"GET /campaigns/external-audience/products","href":"/api-v1/campaigns/audience-products"},{"title":"Update campaign status","api":"POST https://app.famulor.de/api/user/campaigns/update-status","href":"/api-v1/campaigns/update-status"},{"title":"Delete campaign","api":"DELETE /user/campaign/{id}","href":"/api-v1/campaigns/delete"}]},{"group":"Automations","pages":[{"title":"List automations","api":"GET https://app.famulor.de/api/user/automate/flows","href":"/api-v1/automations/list"},{"title":"Get automation","api":"GET https://app.famulor.de/api/user/automate/flows/{id}","description":"Get a single Famulor automation, including its full definition (trigger and chained steps).","href":"/api-v1/automations/get"},{"title":"Create automation","api":"POST https://app.famulor.de/api/user/automate/flows","href":"/api-v1/automations/create"},{"title":"Update automation","api":"PUT https://app.famulor.de/api/user/automate/flows/{id}","description":"Rename a Famulor automation, turn it on or off, or repair it with a corrected definition.","href":"/api-v1/automations/update"},{"title":"Restore previous version","api":"POST https://app.famulor.de/api/user/automate/flows/{id}/restore","href":"/api-v1/automations/restore"},{"title":"Delete automation","api":"DELETE https://app.famulor.de/api/user/automate/flows/{id}","href":"/api-v1/automations/delete"},{"title":"List automation runs","api":"GET https://app.famulor.de/api/user/automate/flows/{id}/runs","href":"/api-v1/automations/list-runs"},{"title":"Retry automation run","api":"POST https://app.famulor.de/api/user/automate/flows/{id}/runs/{run_id}/retry","href":"/api-v1/automations/retry-run"},{"title":"List automation templates","api":"GET https://app.famulor.de/api/user/automate/templates","href":"/api-v1/automations/list-templates"},{"title":"Apply automation template","api":"POST https://app.famulor.de/api/user/automate/templates/{key}","href":"/api-v1/automations/apply-template"}]},{"group":"Mid Call Actions","pages":[{"title":"List Mid-call Actions","api":"GET https://app.famulor.de/api/user/tools","href":"/api-v1/mid-call-tools/get-tools"},{"title":"Get Mid-call Action","api":"GET https://app.famulor.de/api/user/tools/{id}","href":"/api-v1/mid-call-tools/get-tool"},{"title":"Create Mid-call Action","api":"POST https://app.famulor.de/api/user/tools","href":"/api-v1/mid-call-tools/create-tool"},{"title":"Update Mid-call Action","api":"PUT https://app.famulor.de/api/user/tools/{id}","href":"/api-v1/mid-call-tools/update-tool"},{"title":"Delete Mid-call Action","api":"DELETE https://app.famulor.de/api/user/tools/{id}","href":"/api-v1/mid-call-tools/delete-tool"}]},{"group":"AI Chatbot","pages":[{"title":"List Conversations","api":"GET https://app.famulor.de/api/user/conversations","href":"/api-v1/conversations/list"},{"title":"Disable AI","api":"POST https://app.famulor.de/api/automate/conversations/{uuid}/disable-ai","href":"/api-v1/conversations/disable-ai"},{"title":"Enable AI","api":"POST https://app.famulor.de/api/automate/conversations/{uuid}/enable-ai","href":"/api-v1/conversations/enable-ai"},{"title":"Create conversation","api":"POST /conversations","href":"/api-v1/ai-chatbot/create-conversation"},{"title":"Get conversation","api":"GET /conversations/{uuid}","href":"/api-v1/ai-chatbot/get-conversation"},{"title":"Send message","api":"POST /conversations/{uuid}/messages","href":"/api-v1/ai-chatbot/send-conversation"}]},{"group":"AI Replies","pages":[{"title":"Generate AI Reply","api":"POST https://app.famulor.de/api/user/ai/generate-reply","href":"/api-v1/ai-replies/generate-reply"}]},{"group":"Knowledgebases","pages":[{"title":"List Knowledge Bases","api":"GET https://app.famulor.de/api/user/knowledgebases","href":"/api-v1/knowledgebases/list"},{"title":"Get Knowledge Base","api":"GET https://app.famulor.de/api/user/knowledgebases/{id}","href":"/api-v1/knowledgebases/get"},{"title":"Create Knowledge Base","api":"POST https://app.famulor.de/api/user/knowledgebases","href":"/api-v1/knowledgebases/create"},{"title":"Update Knowledge Base","api":"PUT https://app.famulor.de/api/user/knowledgebases/{id}","href":"/api-v1/knowledgebases/update"},{"title":"Delete Knowledge Base","api":"DELETE https://app.famulor.de/api/user/knowledgebases/{id}","href":"/api-v1/knowledgebases/delete"},{"title":"List Documents","api":"GET https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents","href":"/api-v1/knowledgebases/list-documents"},{"title":"Get Document","api":"GET https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId}","href":"/api-v1/knowledgebases/get-document"},{"title":"Create Document","api":"POST https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents","href":"/api-v1/knowledgebases/create-document"},{"title":"Update Document","api":"PUT https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId}","href":"/api-v1/knowledgebases/update-document"},{"title":"Delete Document","api":"DELETE https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId}","href":"/api-v1/knowledgebases/delete-document"}]},{"group":"SMS","pages":[{"title":"Send SMS","api":"POST https://app.famulor.de/api/user/sms","href":"/api-v1/sms/send"}]},{"group":"WhatsApp","pages":[{"title":"Get WhatsApp Senders","api":"GET /user/whatsapp/senders","href":"/api-v1/whatsapp/get-senders"},{"title":"Get WhatsApp Templates","api":"GET /user/whatsapp/senders/{senderId}/templates","href":"/api-v1/whatsapp/get-templates"},{"title":"Send WhatsApp Template Message","api":"POST /user/whatsapp/send","href":"/api-v1/whatsapp/send-template"},{"title":"Send WhatsApp Freeform Message","api":"POST /user/whatsapp/send-freeform","href":"/api-v1/whatsapp/send-freeform"},{"title":"Get WhatsApp Session Status","api":"GET /user/whatsapp/session-status","href":"/api-v1/whatsapp/session-status"}]},{"group":"Phone Numbers","pages":[{"title":"List Phone Numbers","api":"GET https://app.famulor.de/api/user/phone-numbers/all","href":"/api-v1/phone-numbers/list"},{"title":"Update Phone Number","api":"PUT https://app.famulor.de/api/user/phone-numbers/{id}","href":"/api-v1/phone-numbers/update"},{"title":"Search Available Phone Numbers","api":"GET https://app.famulor.de/api/user/phone-numbers/search","href":"/api-v1/phone-numbers/search"},{"title":"Purchase Phone Number","api":"POST https://app.famulor.de/api/user/phone-numbers/purchase","href":"/api-v1/phone-numbers/purchase"},{"title":"Release Phone Number","api":"DELETE https://app.famulor.de/api/user/phone-numbers/{id}","href":"/api-v1/phone-numbers/release"}]},{"group":"SIP Trunks","pages":[{"title":"List SIP Trunks","api":"GET https://app.famulor.de/api/user/phone-numbers/sip-trunks","href":"/api-v1/sip-trunks/list"},{"title":"Get SIP Trunk","api":"GET https://app.famulor.de/api/user/phone-numbers/sip-trunks/{id}","href":"/api-v1/sip-trunks/get"},{"title":"Create SIP Trunk","api":"POST https://app.famulor.de/api/user/phone-numbers/sip-trunks","href":"/api-v1/sip-trunks/create"},{"title":"Update SIP Trunk","api":"PUT https://app.famulor.de/api/user/phone-numbers/sip-trunks/{id}","href":"/api-v1/sip-trunks/update"},{"title":"Delete SIP Trunk","api":"DELETE https://app.famulor.de/api/user/phone-numbers/{id}","href":"/api-v1/sip-trunks/delete"}]},{"group":"Calls","pages":[{"title":"List Calls","api":"GET https://app.famulor.de/api/user/calls","href":"/api-v1/calls/list"},{"title":"Get Call","api":"GET https://app.famulor.de/api/user/calls/{id}","href":"/api-v1/user/calls/get"},{"title":"Make a Call","api":"POST https://app.famulor.de/api/user/make_call","href":"/api-v1/calls/make"},{"title":"Delete Call","api":"DELETE https://app.famulor.de/api/user/calls/{call}","href":"/api-v1/calls/delete"}]},{"group":"Webhooks","pages":[{"title":"Post-Call Webhook","icon":"link","href":"/api-v1/webhooks/post-call"},{"title":"Conversation Ended Webhook","icon":"link","href":"/api-v1/webhooks/conversation-ended"},{"title":"Read Receipts Webhook","icon":"link","href":"/api-v1/webhooks/read-receipts"}]}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/changelog"}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-v1/automations/create"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-v1/automations/create"}]},{"language":"de","pages":[{"title":"de","href":"/de/api-v1/automations/create"}]}]},"title":"Create automation - Famulor","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["BannerMarkdown-Og7hgu7u.js","dist-BaREnp3o.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-CefdjKz2.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js"]}