Skip to content

Action reference ​

Every action an Action step can take: what it does, each setting, and the values it leaves for later steps.

Later steps read a value as {{steps.<step id>.<value>}}. The step id is shown when you click a step in the builder. A test run shows the exact values a step produced.

Any text setting accepts values from the trigger and from earlier steps. See Use values from the trigger and earlier steps.

Workspace ​

Send notification ​

Action key: notify

In-app notification to your team.

Appears in the notification bell and, for people with the mobile app, as a push notification.

Settings

SettingKeyTypeRequiredNotes
TitletitleTextUse {{field}} to insert trigger values.
MessagemessageLong textUse {{field}} to insert trigger values.
WhorecipientsChoiceChoices: everyone, creator, owner, users, role.
UsersuseridsTeam membersShown when recipients=users.
RoleroleChoiceChoices: admin, manager, salesperson. Shown when recipients=role.

Values for later steps

ValueWhat it holds
recipientsHow many people it reached, or everyone.

Celebrate ​

Action key: celebrate

Confetti and a message on the dashboard of everyone it reaches: a deal won, a target hit.

Same as Send notification, plus confetti on the dashboard of everyone it reaches.

Settings

SettingKeyTypeRequiredNotes
TitletitleTextUse {{field}} to insert trigger values.
MessagemessageLong textUse {{field}} to insert trigger values.
WhorecipientsChoiceChoices: everyone, creator, owner, users, role.
UsersuseridsTeam membersShown when recipients=users.
RoleroleChoiceChoices: admin, manager, salesperson. Shown when recipients=role.

Values for later steps

ValueWhat it holds
recipientsHow many people it reached, or everyone.

Alert notification contacts ​

Action key: notify_contacts

SMS, email or WhatsApp to the business's notification contacts.

Goes to the notification contacts set under Settings, on each channel a contact has (SMS, email, WhatsApp). It does not go to customers.

Settings

SettingKeyTypeRequiredNotes
TitletitleTextUse {{field}} to insert trigger values.
MessagemessageLong textUse {{field}} to insert trigger values.

This action leaves no values for later steps.

Email a team member ​

Action key: email_user

Email the automation's author, the record's owner, chosen team members or everyone with a role.

Emails team members, never customers. It cannot go to "everyone": choose the author, the record owner, named users or a role.

Settings

SettingKeyTypeRequiredNotes
SubjecttitleTextUse {{field}} to insert trigger values.
BodymessageLong textYesUse {{field}} to insert trigger values.
WhorecipientsChoiceChoices: creator, owner, users, role.
UsersuseridsTeam membersShown when recipients=users.
RoleroleChoiceChoices: admin, manager, salesperson. Shown when recipients=role.

Values for later steps

ValueWhat it holds
sentHow many team members were emailed.

Tasks ​

Create task ​

Action key: create_task

Create a task linked to the record.

The task is linked to the record that started the automation. "Owner" falls back to the automation's author when the record has no owner.

Settings

SettingKeyTypeRequiredNotes
TitletitleTextUse {{field}} to insert trigger values.
MessagemessageLong textUse {{field}} to insert trigger values.
Assign toassigneemodeChoiceChoices: creator, owner, user, round_robin.
UserassigneeidTeam memberShown when assigneemode=user.
TeamuseridsTeam membersShown when assigneemode=round_robin. Each new record goes to the next person in turn.
Due in (days)dueindaysNumberDefaults to 3.

Values for later steps

ValueWhat it holds
taskidThe new task's ID.
titleThe task title as written.

Complete the task ​

Action key: complete_task

Mark the task that started this automation as completed. For a task found by an earlier step, use the Update task action.

Marks the task that started the automation as completed, exactly as completing it in the dashboard does. Only on task triggers.

This action has no settings.

Values for later steps

ValueWhat it holds
dataThe updated task.

Agents ​

Request agent review ​

Action key: trigger_agent

Ask one of your background AI agents to review this business soon. It runs later on its own; for AI that acts inside this automation use the AI agent step.

Starts one of the AI agents under Agents. The step is skipped, with the reason, when that agent is switched off or has already run recently.

Settings

SettingKeyTypeRequiredNotes
AgentagentkeyAgentYes

Values for later steps

ValueWhat it holds
skippedOnly when the agent did not start: the reason.

Messaging ​

Email the contact ​

Action key: send_email

Email the record's customer or contact. Skipped for anyone who opted out, and the same step reaches a person at most once in 24 hours.

Sends to the contact on the record that started the automation. Counts towards the daily customer message limit. See Messages to customers.

Settings

SettingKeyTypeRequiredNotes
SubjecttitleText
BodymessageLong textYes

Values for later steps

ValueWhat it holds
sent1 when sent.
toThe address it went to.
skippedOnly when nothing was sent: the reason (opted out, or already messaged in the last 24 hours).

SMS the contact ​

Action key: send_sms

Text the record's customer or contact. Skipped for anyone who opted out, and the same step reaches a person at most once in 24 hours.

Sends to the contact on the record. Counts towards the daily customer message limit.

Settings

SettingKeyTypeRequiredNotes
MessagemessageLong textYes

Values for later steps

ValueWhat it holds
sent1 when sent.
toThe number it went to.
skippedOnly when nothing was sent: the reason.

WhatsApp the contact ​

Action key: send_whatsapp

WhatsApp the record's customer or contact. Skipped for anyone who opted out, and the same step reaches a person at most once in 24 hours.

Sends to the contact on the record. Counts towards the daily customer message limit.

Settings

SettingKeyTypeRequiredNotes
MessagemessageLong textYes

Values for later steps

ValueWhat it holds
sent1 when sent.
toThe number it went to.
skippedOnly when nothing was sent: the reason.

Records ​

Assign owner ​

Action key: assign_user

Make a user the record's owner, or share records out among a team in turn.

Sets the owner of the record that started the automation. "Round robin" gives each new record to the next person in the team you list.

Settings

SettingKeyTypeRequiredNotes
Assign toassigneemodeChoiceChoices: user, round_robin.
UserassigneeidTeam memberShown when assigneemode=user.
TeamuseridsTeam membersShown when assigneemode=round_robin. Each new record goes to the next person in turn.

Values for later steps

ValueWhat it holds
assignedtoThe ID of the user the record was given to.

Sequences ​

Enroll in sequence ​

Action key: enroll_in_sequence

Start the lead on a nurture sequence.

Adds the lead or deal's contact to a sales sequence.

Settings

SettingKeyTypeRequiredNotes
SequencesequenceidSequenceYes

This action leaves no values for later steps.

Exit sequence ​

Action key: exit_sequence

Take the lead out of a nurture sequence, so its remaining steps do not run.

Removes the contact from one sequence, or from every sequence when none is chosen.

Settings

SettingKeyTypeRequiredNotes
SequencesequenceidSequenceLeave empty to exit every sequence the lead is in.

This action leaves no values for later steps.

Calculations ​

Calculate ​

Action key: formula

Compute a value for later steps, e.g. amount * 0.1. Later steps use it as {{steps.<step id>.result}}.

Calculates a value without changing anything. See Calculate.

Settings

SettingKeyTypeRequiredNotes
FormulaexpressionTextYesTrigger fields by name (amount, balance...), earlier steps as steps.<id>.<field>. Functions: round, min, max, abs, ceil, floor; two decimals: round(x * 100) / 100.

Values for later steps

ValueWhat it holds
resultThe calculated value: a number, text, date, list or object.

Cashfin actions ​

Run a Cashfin action ​

Action key: tool

Any action you can ask the AI to do: create or update a record, issue a credit note, send an invoice, record a payment...

Runs one Cashfin action: anything the AI assistant can do. Every action is listed in Cashfin actions. Actions that send a document to a customer count towards the daily customer message limit and respect quiet hours.

Settings

SettingKeyTypeRequiredNotes
ActiontoolCashfin actionYes
InputsinputsThe action's own inputsUse {{field}} or {{steps.<id>.<field>}}; a value that is only a placeholder keeps its type.

Values for later steps

ValueWhat it holds
dataWhat the Cashfin action returned. Its shape depends on the action; run a test to see it.

AI ​

AI: sort into a category ​

Action key: ai_classify

AI reads some text and picks one of your categories. Later steps use {{steps.<step id>.category}}, for example in a condition.

See AI text steps.

Settings

SettingKeyTypeRequiredNotes
Text to sortmessageLong textYesUse {{field}} to insert trigger values.
CategoriesoptionsList of wordsYesAt least two, e.g. complaint, question, order.
Picture or file to readfileTextOptional. A link to a picture, PDF or spreadsheet in your media: {{fileurl}} on the File uploaded trigger, or {{steps.<id>.<field>}}. Reading a file uses more AI credits: about 2 extra per picture or PDF page (first 3 pages are read).
ModeltierChoiceChoices: smart, fast. Smart thinks harder; fast is cheaper and quicker. Each run uses AI credits.

Values for later steps

ValueWhat it holds
categoryThe category chosen, spelled as you wrote it.
confidenceHow sure the AI is, from 0 to 1.

AI: pull out details ​

Action key: ai_extract

AI finds the details you name in some text. Later steps use {{steps.<step id>.<detail>}}.

See AI text steps.

Settings

SettingKeyTypeRequiredNotes
Text to readmessageLong textYesUse {{field}} to insert trigger values.
Details to findoptionsList of wordsYesOne name per detail, e.g. budget, deadline, city.
Picture or file to readfileTextOptional. A link to a picture, PDF or spreadsheet in your media: {{fileurl}} on the File uploaded trigger, or {{steps.<id>.<field>}}. Reading a file uses more AI credits: about 2 extra per picture or PDF page (first 3 pages are read).
ModeltierChoiceChoices: smart, fast. Smart thinks harder; fast is cheaper and quicker. Each run uses AI credits.

Values for later steps

ValueWhat it holds
<detail>One value per detail you asked for, named as you wrote it. Empty when the text does not say.

AI: summarise ​

Action key: ai_summarize

AI writes a short summary. Later steps use {{steps.<step id>.text}}.

See AI text steps.

Settings

SettingKeyTypeRequiredNotes
Text to summarisemessageLong textYesUse {{field}} to insert trigger values.
Picture or file to readfileTextOptional. A link to a picture, PDF or spreadsheet in your media: {{fileurl}} on the File uploaded trigger, or {{steps.<id>.<field>}}. Reading a file uses more AI credits: about 2 extra per picture or PDF page (first 3 pages are read).
ModeltierChoiceChoices: smart, fast. Smart thinks harder; fast is cheaper and quicker. Each run uses AI credits.

Values for later steps

ValueWhat it holds
textThe summary.

AI: write or answer ​

Action key: ai_prompt

Ask AI anything: draft a reply, write a note, answer a question. Later steps use {{steps.<step id>.text}}.

See AI text steps.

Settings

SettingKeyTypeRequiredNotes
PromptmessageLong textYesSay what you want written. Use {{field}} to insert trigger values.
Picture or file to readfileTextOptional. A link to a picture, PDF or spreadsheet in your media: {{fileurl}} on the File uploaded trigger, or {{steps.<id>.<field>}}. Reading a file uses more AI credits: about 2 extra per picture or PDF page (first 3 pages are read).
ModeltierChoiceChoices: smart, fast. Smart thinks harder; fast is cheaper and quicker. Each run uses AI credits.

Values for later steps

ValueWhat it holds
textWhat the AI wrote.

AI agent ​

Action key: ai_agent

Give AI a goal and the actions it may use; it decides what to do, step by step. Risky actions wait for your approval. Later steps use {{steps.<step id>.text}}.

See AI agent.

Settings

SettingKeyTypeRequiredNotes
InstructionsmessageLong textYesSay what the agent should achieve. Use {{field}} to insert trigger values.
Actions it may usetoolsCashfin actionsLooking things up runs on its own. Anything that changes records or reaches a customer waits for approval.
Run without approvalautoapproveCashfin actionsActions from the list above you trust the agent to take alone. Sending money, refunds and deletes always wait.
ModeltierChoiceChoices: smart, fast. Smart thinks harder; fast is cheaper and quicker. Each run uses AI credits.
Most actions per runmaxcallsNumberStops a confused agent. 10 when empty, at most 25.

Values for later steps

ValueWhat it holds
textThe agent's final report.
toolcallsHow many actions it took.
callsEach action it took: the action, its inputs, and the result or error.

Integrations ​

Send HTTP request ​

Action key: http_request

Call another system's API over https. Later steps use {{steps.<step id>.status}}, {{steps.<step id>.body}} and, for a JSON reply, {{steps.<step id>.json.<field>}}.

See Call another system from a step.

Settings

SettingKeyTypeRequiredNotes
MethodmethodChoiceChoices: GET, POST, PUT, PATCH, DELETE. POST when empty.
AddressurlTextYesA public https address. Use {{field}} to insert trigger values.
HeadersheadersOne per lineOne per line, as Name: value. Values are hidden once saved.
BodymessageLong textUsually JSON. Use {{field}} to insert trigger values.

Values for later steps

ValueWhat it holds
statusThe HTTP status code.
bodyThe reply as text.
json.<field>A field of a JSON reply.

Cashfin Business API Documentation