Skip to content

Flow final actions

Look up what a Flow needs to work as a final action and what each setting does.

Professional and Ultimate

How final actions work is explained in How final actions work. Step-by-step instructions are in Create a Flow final action.

The Flow must be an active Autolaunched Flow without a trigger. CAB reads the input variables of its active version: every variable marked as available for input with one of the types below. Other variables don’t appear.

Flow variableIn CABValue
Record collection of the audience object (Account, Contact or Lead)Audience ResultsThe audience’s results, always. It can’t be changed.
TextText fieldA default, changeable when the action runs
NumberNumber fieldSame
DateDate fieldSame
Date/TimeDate and time fieldSame
BooleanList with True and FalseSame
Record (single)Record search for the variable’s objectSame

Other collections aren’t offered. In the last step of the setup, each variable has a switch, Include or Don’t include; only included variables reach the Flow. A variable without a label shows its API name.

The record collection contains the audience fields you chose in the setup; Id is always included. With large results, the Flow runs once per batch, each time with the next part of the results.

These settings apply to Flow and Apex final actions alike. They’re set in CAB Settings → Configure → Automation → Configure Final Actions.

SettingValuesNotes
Final Action NameText; requiredThe name in the results menu and in schedules.
API NameText; requiredFilled from the name when you leave the name field. Passed to Apex as actionApiName.
Metadata TypeAutolaunched Flow, ApexCan’t be changed after saving.
Flow or Apex ClassAn active Autolaunched Flow, or a class that implements a final action interfaceCan’t be changed after saving.
DescriptionRich text, up to 15,000 charactersShown in the window before the action runs.
Success MessageText, up to 255 charactersUnder Show Advanced. Shown when a run finishes right away.
Custom Permission NameAPI name of a custom permission, up to 85 charactersUnder Show Advanced. Only users with that permission see the action.
Batch SizeNumber; required; default 500Under Show Advanced. Up to this many results, the action runs right away; above, it runs in the background in batches of this size.
Audience ObjectThe audience objectsUnder Select Audience Object. The action is offered only for audiences with this object. Can’t be changed after saving.
FieldsFields of the audience objectUnder Set Available Fields. The fields the logic reads; Id is always included.
InputsSee Input variables; for Apex, inputs you createUnder Set Input Values.

A new final action is active. In Configure Final Actions, you can deactivate, edit or delete it.