> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflow triggers and steps reference

> Every Agentic Workflows trigger and step with what it does, its key data and inputs, and which ones need an integration, channel or setting turned on.

This page lists every trigger and step in the workflow editor, with the names the editor shows. Use it to find the right trigger for an event, or to check whether a step needs an integration, a channel or a setting before you build with it.

> [!NOTE]
>
> The editor lists these under **TRIGGERS**, **ACTIONS** and **BLOCKS** when you click **+** in [Agentic Workflows](https://platform.open.cx/workflows). Once a workflow has a trigger, the editor only offers the steps that work with it.

| Section | What's in it |
| - | - |
| [Session triggers](#session-triggers) | Created, updated, reassigned, resolved, reopened, inactive, handed off |
| [Message and AI triggers](#message-and-ai-triggers) | Contact messages, agent messages and mentions, AI replies, AI Trigger |
| [Manual, macro and CSAT triggers](#manual-macro-and-csat-triggers) | Run from the session sidebar, macros, CSAT ratings |
| [Schedule, webhook and form triggers](#schedule-webhook-and-form-triggers) | Cron, inbound URL, form submissions |
| [Contact, agent, SLA, phone and sequence triggers](#contact-agent-sla-phone-and-sequence-triggers) | Everything else |
| [Steps](#steps) | Every step, grouped by what it works on |
| [Requirements](#steps-that-need-an-integration-channel-or-setting) | Steps and triggers that only work with a given setup |

Some names use the word "ticket" (**Ticket Created**, **Tag Ticket**). They act on OpenCX sessions. Inputs named **Ticket Number** take the session number.

## Triggers

Each workflow has one trigger. Its data is available to every step as `{{trigger.…}}`; see [variables](https://docs.open.cx/workflows/build-a-workflow.md#pass-data-between-steps-with-variables).

Most session triggers also accept **Channels**, **Directions** and **Statuses** filters and a **Run Synchronously** option, set on the trigger in the editor.

### Session triggers

| Name | Fires when | Key data it provides |
| - | - | - |
| **Ticket Created** | A new session is created. | The session: number, ID, channel, direction, assignee, team, last message, customer email, custom data, skills |
| **Sub-session Created** | An agent creates a sub-session under a parent session. Sub-sessions that a workflow's **Create Sub-session** step opens don't fire it. | The new sub-session, including its parent |
| **Session Updated** | A session's assignee, team, status, sub-status or attributes change. Use **Watched Fields** to run only when specific fields change. | The session, **Changed Fields**, and **Changes** with each previous and new value |
| **Ticket Reassigned** | A session is reassigned to another agent. | The session, previous assignee, new assignee |
| **Ticket Team Changed** | A session moves to a different support team, manually, by auto-assignment or by another workflow. Optionally narrow it to moves into specific teams. | The session, previous team, new team |
| **Tag Added to Ticket** | A tag is added to a session. | The session, the tag |
| **Ticket Resolved** | A session is resolved. Optionally narrow it with **AI closure types**. | The session, AI closure type, status, summary |
| **Ticket Reopened** | A closed session moves back to open. Optionally narrow it with **Reopened by**. | The session, who reopened it, previous status |
| **Customer Inactive** | The customer hasn't replied for **Inactive For** a number of seconds, minutes, hours or days. Options: **Verified Tickets Only**, **AI Assisted Only**, **Only Once**, **After AI Reply**, **After Agent Reply**, and **Also run while snoozed** when session snoozing is on. | The session |
| **Human Agent Inactive** | The human agent on a session is inactive for **Inactive For** a set time. | The session |
| **Pre Ticket Handed Off** | Right before the AI hands a session to a human. The handoff waits for the workflow. | The session |
| **Ticket Handed Off** | The AI hands a session to a human agent. | The session, handoff summary, sentiment, whether it was within office hours, whether it was an emergency handoff |
| **Prohibited Topic Detected** | The AI detects that the customer is discussing a prohibited topic. | The session, the topic |

### Message and AI triggers

| Name | Fires when | Key data it provides |
| - | - | - |
| **Contact Message Received** | A contact sends a message. | The session, message text, message ID, whether it's the first message, email details |
| **First Contact Message Received** | Only on the contact's first message in a session. Use it for greetings without an If Block. | The session, message text, message ID |
| **AI Response Requested** | Right before the AI writes a reply, only when the AI would actually reply and only on the channels you pick. Turn on **Ignore Automated AI Response** to skip the built-in AI reply and let the workflow decide how to respond. | The session, the customer's message |
| **AI Response Completed** | After the AI writes a reply to a contact message and it's saved. | The session, reply text, message ID, knowledge sources and instructions used |
| **AI Trigger** | The AI decides to call the workflow during a session. Set **The Goal of the Workflow** (when to call it), **Payload Shape** (the data to collect first), **Instructions After Execution**, **Async Execution**, **Max Calls Per Session** and **Channels**. | The session, **AI Payload** (the collected data), call details when on a phone call |
| **Agent Message Posted** | A human agent posts a reply or an internal note. Optionally narrow it to replies or notes. AI replies and notes written by workflows never fire it. | The session, the message, its author, mentioned agents |
| **Agent Mentioned** | An agent or team is @-mentioned in an internal note or an Internal session message. Optionally narrow it to specific agents, including through their teams. | The session, the note, its author, mentioned agents and teams |

### Manual, macro and CSAT triggers

| Name | Fires when | Key data it provides |
| - | - | - |
| **Manual Ticket Trigger** | An agent runs it on a session from the **Run Workflow** card in the inbox. | The session (under `trigger.ticket`), **Form Data** |
| **Manual Trigger** | Someone clicks **Run** in the **Runs** panel of the workflow's active version. | None |
| **Macro Called** | An agent sends a specific macro from the inbox. | The session, the macro: ID, name, raw template, rendered message |
| **Macro Option Clicked** | A contact taps a workflow option on a specific macro an agent sent. | The session, the macro, the option (ID and label), message ID |
| **CSAT Score Submit** | A customer submits a CSAT rating. | The session, contact, score, comment |

**Run a workflow from a session.** Active **Manual Ticket Trigger** workflows appear in the **Run Workflow** card in the session sidebar of the [inbox](https://platform.open.cx/inbox). The agent picks one and clicks **Run workflow**; the workflow's description is shown in the dialog. To ask the agent for details first, add fields to the trigger's **Form Schema**: the dialog shows them as a form, and the answers reach the workflow as `{{trigger.formData.<field>}}`. Running needs **Workflows** (Write), **Run workflows** (Write), or **Assigned sessions** (Write) on a session the agent can see.

**Run a workflow from a macro.** Pick the macro in the **Macro Called** trigger, or link the workflow from the macro's **Workflows** field in [Settings → Macros](https://platform.open.cx/settings/saved-replies). See [CSAT](https://docs.open.cx/resources/csat.md) for collecting the ratings that **CSAT Score Submit** reacts to.

### Schedule, webhook and form triggers

| Name | Fires when | Key data it provides |
| - | - | - |
| **Cron Trigger** | On the schedule in **Cron Expression**, for example `0 9 * * 1-5` for weekdays at 9 AM. Schedules created in the editor run in UTC. **Run Limit** caps the number of runs; after the last one the workflow is deactivated automatically (set 1 for a one-off). | Cron expression, scheduled time, fire number, run limit |
| **Webhook** | Something sends a request to the workflow's URL. | Request **Body**, **Query Parameters** |
| **Form Submit** | A form is submitted and matches the trigger's **Form Schema**. | Form ID, form data, submitted time, body |

After you activate a **Webhook** or **Form Submit** workflow, click **Guide** at the top of the editor. For a webhook it shows the **Trigger URL**, its access level and a curl example; the URL stays the same across versions. With **Access Control** set to **Private (Authentication Required)**, callers send an API key with the **Trigger and invoke workflows** scope, created in [Settings → API Tokens](https://platform.open.cx/settings/access). **Public (No Authentication)** lets anyone with the URL run the workflow. For a form, the guide shows the **Form ID** and example requests.

### Contact, agent, SLA, phone and sequence triggers

| Name | Fires when | Key data it provides |
| - | - | - |
| **Contact Created** | A contact is created, in the dashboard or during a session. | The contact |
| **Contact Updated** | A contact changes through the dashboard, the contacts API or a workflow step. Bulk CSV imports don't fire it. A workflow that updates the same contact fires itself again, so check **Changed Fields** in an If Block first. | The contact, **Changed Fields** |
| **Agent Availability Changed** | An agent turns their availability on or off by hand (not office hours). | The agent, whether they're available |
| **Agent Availability in Team Changed** | An agent turns their availability in a support team on or off by hand. | The team, the agent, whether they're available |
| **SLA First Reply Breached** | A session misses its first reply SLA target. | The session, SLA policy, breached metric, elapsed time |
| **SLA Next Reply Breached** | A session misses its next reply SLA target. | Same as above |
| **SLA Resolution Breached** | A session misses its resolution SLA target. | Same as above |
| **Call Started** | A phone call begins. | The call, the phone agent |
| **Pre-Call Finished** | Right before a phone call ends, before **Call Finished**. The call waits for the workflow. | The call, the phone agent |
| **Call Finished** | A phone call ends. | The call, the phone agent |
| **Pre-Voice Call Transfer** | Right before a voice call is transferred. The transfer waits for the workflow. | The session, destination, transfer reason, the call, the phone agent |
| **Voice Call Transferred** | After a voice call is transferred. | The session, destination, transfer reason, the call, the phone agent |
| **IVR Incoming Call** | An inbound call reaches a number assigned to this IVR in **Channels → Phone → Classical IVR**. | Session number and ID, caller number, dialed number |
| **Sequence Contact Replied** | A contact replies to a sequence message or answers a sequence call. | The contact, sequence, step, session, reply |
| **Sequence Contact Completed** | A contact reaches the end of a sequence without replying. | The contact, sequence, step |
| **Sequence Contact Parked** | A contact is parked on a sequence step and needs data or a fix to continue. | The contact, sequence, step, why it's parked |
| **Sequence Contact Suppressed** | A contact leaves a sequence because every address it could use is blocked. | The contact, sequence, step |
| **Sequence Step Failed** | A sequence step fails for good: a bounce, an unanswered call, an unreachable number. | The contact, sequence, step, the failure |

The sequence triggers can each be narrowed to specific sequences.

## Steps

### Blocks and flow

| Name | What it does | Notable inputs |
| - | - | - |
| **If Block** | Sends the run down a true or false path based on conditions. | Conditions, **AND** / **OR** / **NOT** groups |
| **Wait** | Pauses the run, up to 30 days in total. The run shows as **Waiting** meanwhile. | **Amount**, **Unit** |
| **Note** | A note to yourself on the canvas. Never runs. | Text |
| **Hold Variable** | Keeps a value under a name for later steps. | **Value Name**, **Value** |
| **Map Lookup** | Looks up a value in a key-value map. | **Entries**, **Lookup Key**, **Default Value**, **Throw If Not Found** |
| **Aggregate Workflow Results** | Ends the run and returns one combined result, shown in the run's **Output** tab. | **Result** |
| **Get Current Run Details** | Reads details of the current run. | **Run ID**, **Run Trigger Cause** |

### Session status, assignment and routing

| Name | What it does | Notable inputs |
| - | - | - |
| **Create Ticket** | Creates a new session. | **Channel** |
| **Create Sub-session** | Creates a sub-session under an existing session. | **Parent Session Number**, **Channel**, **Title**, team |
| **Close Ticket** | Closes a session. | **Ticket Number**, **Reason**, **Resolved**, **Close in Third Party Ticketing Integration** |
| **Close Contact Tickets** | Closes every session of a contact. | **Contact ID**, **Status** |
| **Reopen Ticket** | Sets a session to open, clearing its custom status and Snooze. | **Ticket Number** |
| **Merge sessions** | Permanently merges one or more sessions into a primary session. | **Primary session number**, **Source session numbers**, **Source closure status** |
| **Apply Custom Status** | Applies a custom status. | **Ticket Number**, **Custom Status** |
| **Snooze Session** | Snoozes a session for a set time. | **Session Number**, **Snooze Duration** |
| **Set session priority** | Sets or clears a session's priority. | **Session number**, **Priority** |
| **Set session subject** | Sets or overwrites a session's subject. | **Session number**, **Subject** |
| **Set Session Language** | Records the language the customer speaks, for example from an IVR choice. | **Ticket Number**, **Language** |
| **Set Conversation Mode** | Switches a session between Autopilot and Assist mode. | **Ticket Number**, **Mode** |
| **Assign Ticket to AI** | Assigns a session back to the AI so Autopilot resumes handling it. | **Ticket Number** |
| **Unassign AI** | Takes the AI off a session and leaves it unassigned, optionally in a team queue. No AI reply follows. | **Ticket Number**, **Team ID** |
| **Change Ticket Assignee** | Changes a session's assignee. | **Ticket Number**, **Assignee**, **Reason** |
| **Assign Ticket to Support Team** | Assigns a session to a specific team. | **Ticket Number**, **Team**, **Skill-based routing**, **Shallow assignment** |
| **Auto Assign to Support Team** | Picks a team for a handed-off session from its summary. | **Ticket Number**, **Fallback Support Team**, **Skill-based routing** |
| **Assign Skills to Ticket** | Adds skills to a session. | **Ticket Number**, **Skills** |
| **Handoff to Human Agent** | Hands a session off to a human agent. | **Ticket ID**, **Summary**, **Explanation**, **Sentiment**, **Retry If Already Handed Off** |
| **Release Session From Capacity** | Stops counting the session toward the assignee's capacity until the customer replies. | **Ticket Number** |
| **Unassign Human Agent Open Sessions** | Unassigns an agent from all their open sessions. | **Assignee**, **Team** |
| **Tag Ticket** / **Remove Tag from Ticket** | Adds or removes a tag. | **Ticket Number**, **Tag** |
| **Auto Tag Ticket** | Tags a session automatically. | **Ticket Number**, **Fallback Tag** |
| **Apply SLA** | Applies an SLA policy, optionally replacing the current one. | **Ticket Number**, **SLA Policy**, **Replace existing SLA** |
| **Pause SLA** | Pauses the resolution timer; it resumes when the customer replies or the session reopens. | **Ticket Number** |
| **Get Applied SLA** | Reads the SLA policy on a session. | **Ticket Number** |

### Replies, notes and outbound messages

| Name | What it does | Notable inputs |
| - | - | - |
| **Reply to ticket** | Sends a reply on a session. | **Ticket Number**, **Message**, **Quick Reply Suggestions**, **Attachments**, **Fulfill SLA**, **Send to Third Party Ticketing Integration** |
| **Send macro** | Sends an org-wide macro, with its options and attachments. | **Session Number**, **Macro**, **Language**, **Fulfill SLA** |
| **Append note** | Adds an internal note to the session. | **Ticket Number**, **Note**, **Mention Agents**, **Mention Teams** |
| **Send Email Template** | Sends an email template from a chosen sender. | **Email Template**, **From Domain**, **From Prefix**, **From Name**, **Contact ID**, **Cc**, **Bcc**, **Reply-To**, **Attachments** |
| **Send WhatsApp Template** | Sends an approved WhatsApp template to a contact. | **Contact ID**, **WhatsApp Number**, **WhatsApp Template**, **Template Variables** |
| **Send Webhook** | Sends a webhook to a URL. | **URL**, **HTTP Method**, **Headers**, **Body Parameters** |
| **Make HTTP request** | Calls any URL and returns the response to later steps. | **URL**, **HTTP Method**, **Headers**, **Body**, **Response Schema** |
| **Make authenticated ticketing request** | Calls your connected ticketing system's API with its saved credentials. | **Path**, **HTTP Method**, **Body**, **Response Schema** |
| **Send CSAT Request** | Sends a CSAT survey on a session. | **Ticket Number**, **Custom Message** |
| **Generate CSAT Link** | Creates a CSAT survey link for a session. | **Ticket Number** |
| **Get CSAT Score** | Reads the CSAT score and feedback. | **Ticket Number** |
| **Cancel CSAT Request** | Voids an outstanding CSAT request so a late rating isn't accepted. Doesn't unsend a survey or change a rating already given. | **Ticket Number**, **Session ID** |

### AI steps

| Name | What it does | Notable inputs |
| - | - | - |
| **Ask AI** | Asks the AI a question and returns its answer as **Result**. | **Prompt**, **Images**, **Expected Output**, **AI Speed**, **Use AI Instructions**, **Use Knowledge Base** |
| **Ask AI About Ticket** | Asks the AI about a session's history. | **Ticket Number**, **Prompt**, **Expected Output** |
| **Ask AI About Data** | Asks the AI about data you pass in. | **Prompt**, **Data**, **Expected Output** |
| **Respond with AI** | Has the AI write and send a reply to the latest contact message. | **Ticket Number**, **Context**, **Is Assist Mode** |
| **Start AI Session** | Opens a new session and has the AI act on your instructions in it. | **Instructions**, **Channel**, **Contact ID**, **Title** |
| **Extract Contact Info** | Reads the session with AI to find name, email and phone, then updates the contact. | **Ticket Number**, **Extract Name**, **Extract Email**, **Extract Phone** |
| **Fill Structured Fields with AI** | Records structured field values on a session from its messages. | **Ticket Number**, **Instructions**, **Overwrite Existing Values** |
| **Fill Contact Structured Fields with AI** | Records structured field values on the session's contact. | **Ticket Number**, **Instructions**, **Overwrite Existing Values** |
| **Translate Text** | Translates text into another language. | **Text**, language |
| **Add to Knowledge Base** | Stores one or more documents in the knowledge base so the AI can answer from them. | **Document(s)**, **Folder**, **Visibility** |

Set **Expected Output** on the AI steps to get named fields back, for example `{{ask_ai.result.category}}`.

### Sessions, contacts and companies data

| Name | What it does | Notable inputs |
| - | - | - |
| **Get Session By Ticket** | Reads a session: status, channel, contact, custom data. | **Ticket Number** or **Session ID**, **Include Attachments** |
| **Get Assigned Agent to Ticket** | Reads the session's assignee. | **Ticket Number** |
| **Get Ticket Tags** | Reads the session's tags. | **Ticket Number** |
| **Get Ticket External IDs** | Reads linked IDs in other systems, such as a Zendesk ticket ID. | **Ticket Number** |
| **Merge Custom Data** | Merges custom data into a session. | **Ticket Number**, **Custom Data**, **Sync to connected integration** |
| **Set Session Structured Field Value** / **Set Contact Structured Field Value** | Records a structured field value on a session or contact. | **Structured Field**, **Value** |
| **Set Structured Field Value** | Sets a text, number, boolean or date structured field. | **Structured Field**, **Value** |
| **Update Structured Field or Choice** | Renames, redescribes or deletes a structured field or one of its choices. | **Structured Field**, **Name**, **Description**, **Delete** |
| **Add Contact** / **Update Contact** | Creates a contact, or changes its name, email or phone. | **Name**, **Email**, **Phone** |
| **Find Contact** | Finds a contact by phone number or custom attributes. | **Phone Number**, **Attribute Filters** |
| **Get Contact Details** | Reads a contact. | **Contact ID** |
| **Update Contact Attributes** | Merges verified or non-verified attributes into a contact. | **Contact ID**, **Custom Data**, **Attribute Type** |
| **Set Contact HTTP Headers** | Stores headers the AI sends on every AI Action call for this contact. | **Contact ID**, **Headers** |
| **Restrict Contact Channels** | Changes the channels a contact must not be contacted on. | **Contact ID**, **Change**, **Channels** |
| **Add Contact to Segment** / **Check Contact In Segment** | Adds a contact to a segment, or checks membership. | **Contact ID**, **Contact Segment** |
| **Create or Update Company** | Creates or updates a company, matched on your company ID. | **Company ID**, **Company Name**, **Company Attributes** |
| **Link Contact to Company** / **Unlink Contact from Company** | Adds or removes a company on a contact. | **Contact ID**, **Company ID** |
| **Get Contact Companies** | Reads a contact's companies and their attributes. | **Contact ID** |
| **Set Company Owner** | Assigns the teammate who owns a company. | **Company ID**, **Owner Email** or **Owner Agent ID** |
| **Update Global Variables** | Updates your workspace global variables. | **Global Variables** |
| **Block IP** / **Unblock IP** | Blocks an IP address or range from reaching the AI, or lifts the block. | **IP Address**, **Reason**, **Expires After (hours)** |
| **Count Recent Sessions From IP** | Counts sessions an IP opened in a recent window. | **IP Address**, **Window (minutes)** |
| **Monitor Session Volume** | Counts sessions in a rolling window. Needs a **Cron Trigger** that fires at least five minutes apart. | **Tag**, **Window (minutes)** |
| **Get Default Working Hours** / **Get Custom Working Hours** | Checks whether now is within your office hours. | **Custom Office Hours** |

### Documents, web and text

| Name | What it does | Notable inputs |
| - | - | - |
| **Run Code** | Runs a JavaScript snippet. See [Run Code](#run-code). | **Code** |
| **Clean Text** | Strips HTML tags and cleans up text. | **Text to Clean**, **Preserve Line Breaks** |
| **Scrape URL** | Turns one HTTPS web page into text. Pair it with **Ask AI About Data**. | **URL**, **Only main content**, **Allowed domains** |
| **Fetch PDF from URL** | Downloads a public PDF for later steps. | **PDF URL**, **File name** |
| **Parse document** | Turns a PDF, DOCX or image into text for AI steps. | **URL**, **Tier**, **Custom Prompt** |
| **Extract document images** | Pulls the images out of an Office document. | **Document URL**, **Max images** |
| **Read spreadsheet from URL** | Reads a CSV or XLSX file's rows. | **URL**, **Max Rows**, **Sheet Name** |
| **Describe spreadsheet from URL** | Reads only a spreadsheet's sheets, headers and row counts. | **URL**, **Include sample row** |
| **Transcribe voice recording** | Transcribes a session's voice recording. | **Session ID**, **Transcription Model**, **Language**, **Separate speakers** |

### Slack

| Name | What it does | Notable inputs |
| - | - | - |
| **Send Message to a Slack Channel** | Posts to a channel or thread, with mentions and duplicate protection. | **Channel**, **Message**, **Mentions**, **Reply to Thread**, **Dedupe Key** |
| **Find Slack Messages** | Finds messages by dedupe key or channel history. | **Dedupe Key**, **Channel**, **Text Contains** |
| **Retrieve Slack Thread Messages** | Reads a thread, with a transcript ready for **Ask AI**. | **Channel**, **Thread** |
| **Add Reaction to Slack Message** | Adds an emoji reaction. | **Channel**, **Message**, **Reaction (Emoji) Name** |
| **Trigger Slack Workflow** | Starts a Slack workflow through its webhook. | **Workflow Webhook URL**, **Variables** |

### Sequences and outbound blocklist

| Name | What it does | Notable inputs |
| - | - | - |
| **Add Contact to Sequence** / **Remove Contact from Sequence** | Enrolls a contact in a sequence, or takes them out. | **Sequence**, **Contact ID**, **Phone Number**, **Email** |
| **Get Sequence Contact** / **List Contact Sequences** | Reads a contact's state in a sequence, or every sequence they're in. | **Sequence**, **Contact ID** |
| **Continue Sequence for Contact** | Puts a contact back in a sequence at the next step after a reply took them out. | **Sequence**, **Contact ID** |
| **Include Sequence Contact Anyway** | Overrides a below-cutoff judgment so the contact can be sent to. | **Sequence**, **Contact ID** |
| **Update Sequence Contact** | Corrects a contact's name or handles in a sequence. | **Sequence**, **Contact ID** |
| **Skip Sequence Step** | Skips a pending step for one contact. | **Sequence**, **Contact ID**, **Skip mode**, **Step**, **Channel** |
| **Add to Outbound Blocklist** / **Remove from Outbound Blocklist** / **Check Outbound Blocklist** | Blocks, unblocks or checks an address for outbound contact. | **Identity Type**, **Identity Value** |

### Phone and Classical IVR

| Name | What it does | Notable inputs |
| - | - | - |
| **Make phone call** | Places an outbound call with an AI phone agent and records it. | **Contact Number**, **Phone Agent**, **Extra Instructions** |
| **Get Phone Call Details** | Reads pickup, waiting time and who ended a call. | **Session ID**, **Call ID** |
| **Transfer to AI phone agent** | Hands the live caller to an AI phone agent. Works with **IVR Incoming Call**, **Pre-Call Finished** and **AI Trigger**. | **Phone agent**, **Context for the agent** |
| **Speak Text** | Reads a script, or repeats collected digits, to the caller. | **Text**, **Read numbers digit by digit** |
| **Play WAV recording** | Plays an uploaded recording. | **WAV recording** |
| **Collect Digits** / **Keypad Menu** | Collects keypad input; branch on the outcome. | **Menu WAV recording**, **Menu text** |
| **Transfer Call** | Rings team members, an external number or a SIP destination, with optional hold music and announcements. | **Transfer Destination**, **Record human call** |
| **Record Voicemail** | Plays a greeting and tone, records the caller, and delivers the message and callback number to a team. | Recording, team, **Callback number**, **Maximum message length (seconds)** |
| **Save Keypad CSAT Rating** | Saves the caller's keypad rating to the session's CSAT reporting. | **Rating collection step ID** |
| **End Call** | Hangs up. | None |

### Integration steps

| Name | What it does | Notable inputs |
| - | - | - |
| **Create Zendesk Ticket from Session** | Creates a Zendesk ticket from a session and returns its ID and **Ticket URL**. | **Session ID**, **Ticket Subject**, **Initial Comment**, **Tags** |
| **Update Zendesk Custom Field** | Writes a Zendesk ticket or contact field. | **Ticket Number**, **Zendesk Field**, **Value** |
| **Merge Zendesk Ticket** | Merges the linked Zendesk ticket into another. | **Ticket Number**, **Target Zendesk Ticket ID** |
| **Start Zendesk Side Conversation** / **…with Agent or Team** | Opens a side conversation on the Zendesk ticket from a template. | **Ticket Number**, **Email Template**, **Send To** |
| **Create HubSpot Ticket from Session** | Creates a HubSpot ticket from a session. | **Session ID**, **Ticket Subject**, **HubSpot Pipeline**, **Hand Off to a Human** |
| **Update HubSpot Record** | Updates one HubSpot ticket, contact or custom-object property. | **Session ID**, **Object Type**, **HubSpot Property**, **Value** |
| **HubSpot Handoff** | Hands a session to HubSpot and assigns it. | **Session**, **Assignee** |
| **Email a Third Party (HubSpot)** | Emails a third party on the HubSpot thread, without the customer. | **Ticket Number**, **To**, **Subject**, **Message** |
| **Update Salesforce Case** / **Merge Salesforce Case** | Writes fields to, or merges, the linked Salesforce case. | **Ticket Number**, **Case Fields** |
| **Lookup Salesforce Record** | Reads any Salesforce record by ID. | **Record ID** |
| **Create Salesforce Case from Session (CRM)** | Creates a Salesforce case from a session through the Salesforce CRM connection. | **Session ID**, **Subject**, **Include Transcript** |
| **Update Salesforce Record (CRM)** / **Log Salesforce Activity (CRM)** | Updates the linked Salesforce contact or lead, or logs an activity on it. | **Session ID**, **Fields** |
| **Create Genesys Workitem** / **Update Genesys Workitem** | Creates or updates the session's Genesys Cloud workitem. | **Session ID**, **Queue ID**, **Priority** |
| **Transfer To Genesys Queue** / **Merge Genesys Session** | Moves the session's Genesys Cloud conversation to a queue, or merges sessions and ends the merged conversation. | **Session ID**, **Queue ID** |
| **Post Call Context to Aircall** | Attaches the session context to the Aircall call after the AI transfers it. | **Aircall API ID**, **Aircall API Token**, **Caller Phone Number** |
| **Update PipeDrive Lead** | Finds and updates a PipeDrive lead. | **PipeDrive API Token**, **Company Domain**, **Field Updates** |

### Run Code

**Run Code** runs a JavaScript snippet. The **Code** field starts as `return {}`: whatever you return becomes the step's **Result**, which later steps read as `{{run_code.result}}`. Inside the code, the trigger and earlier steps' data are on `$ctx`, and the editor autocompletes its fields. Code can't import modules or use `eval`. A run fails if the code throws or doesn't finish in time.

## Steps that need an integration, channel or setting

| Steps or triggers | Needs |
| - | - |
| Zendesk, HubSpot, Salesforce and Genesys steps | That integration connected. The **(CRM)** Salesforce steps use the Salesforce CRM connection. |
| **Make authenticated ticketing request**, **Close in Third Party Ticketing Integration**, **Send to Third Party Ticketing Integration** | A connected ticketing system |
| Slack steps | Slack connected to your workspace |
| **Send WhatsApp Template** | A WhatsApp number and an approved template |
| **Snooze Session**, **Also run while snoozed** | Native OpenCX ticketing and **Enable session snoozing** in [Settings → Workspace](https://platform.open.cx/settings/workspace) |
| **Set session priority** | Native OpenCX ticketing and **Enable session priority** in Settings → Workspace |
| Phone triggers, **Make phone call**, **Get Phone Call Details** | The phone channel |
| **IVR Incoming Call** and the Classical IVR steps (**Speak Text**, **Play WAV recording**, **Collect Digits**, **Keypad Menu**, **Transfer Call**, **Record Voicemail**, **Save Keypad CSAT Rating**, **End Call**) | Telephony with Classical IVR turned on for your workspace. The steps only work in an **IVR Incoming Call** workflow on a live call. |
| SLA triggers, **Apply SLA** | An SLA policy in [Settings → SLA](https://platform.open.cx/settings/sla) |
| Sequence triggers and steps | Sequences |

***

## Related Documentation

> [card] [Build a workflow](https://docs.open.cx/workflows/build-a-workflow.md)
>
> Canvas, conditions, variables.

> [card] [Test and monitor](https://docs.open.cx/workflows/test-and-monitor.md)
>
> Test runs and failure states.

> [card] [Workflows overview](https://docs.open.cx/workflows/introduction.md)
>
> Use cases, life cycle, permissions.

> [card] [Workflows API](https://docs.open.cx/api-reference/workflows/index.md)
>
> Create and trigger workflows by API.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.