Skip to content

Custom workflows settings

Custom workflows are flows you build from blocks on an agent's Custom workflows tab. A Trigger block starts each one. The blocks after it collect details, branch, open helpdesk tickets, call webhooks, ask an AI model, show messages or hand the chat to a person in Zendesk.

Custom workflows are step-by-step flows the AI Shopping Assistant runs when a shopper’s message matches a trigger. You build them on the Custom workflows tab of an agent, in a builder where blocks stack from top to bottom. Every workflow starts with a Trigger block. The blocks after it collect details, branch, open helpdesk tickets, call webhooks, ask an AI model, show messages, wait, suspend a visitor or hand the chat to a person in Zendesk.

A custom workflow runs only while its own Status is on. Once a workflow starts, it keeps the conversation until it ends. The Custom Workflow specialist agent runs them. Specialist agents explains how it fits with the others.

The Webscale AI app inside Shopify admin doesn’t show the Custom workflows tab in its standard view. The Integrations page isn’t available inside Shopify either, so Freshdesk and Gorgias can’t be connected from there.

The Custom workflows tab lists the agent’s workflows, 10 to a page. With nothing to show, the list reads “No workflows found”.

Control What it does
Create custom workflow Opens the builder for a new workflow. The workflow appears in the list after its first save
Search Filters the list by the text you type
Date range Filters the list by date
Status filter Shows active or inactive workflows
Archived Shows archived workflows
Column What it shows
Name The workflow’s title
Status A switch and a badge. Turning the switch on or off takes effect immediately. A new workflow saves with Status on
Created When the workflow was created
Row menu item Effect
Edit Opens the workflow in the builder
Rename Changes the workflow’s title
Archive or Unarchive Moves the workflow to or from the Archived view
Delete Deletes the workflow

The builder shows the workflow’s blocks from top to bottom, with a panel of blocks on the left. The panel’s Blocks tab reads “Click or drag a block onto the canvas.”

Element What it does
Title Names the workflow. Defaults to “Custom workflow”. Select the pencil icon to rename it
Save status Shows Saving…, Unsaved or Saved
+ between blocks Inserts a new block at that point
Drag Reorders blocks
/ in a field Opens a list of values from earlier blocks, such as the email a Form block collected
Setup tab Connection and Action event for the helpdesk blocks. Shown first on those blocks only
Configure tab The block’s own fields
Test tab Tries the open block. On a Webhook block it sends a test request. On an LLM block it runs the prompts with sample values under DATA IN and shows the ANSWER. Other blocks have no test
Delete Block Removes the open block
Save Saves the whole workflow, from the panel footer or the top of the builder. A saved workflow shows “Custom workflow saved successfully”

The Trigger block is always the first block. It decides when the workflow starts.

Field What it does Allowed values Default
Title Names the block on the canvas Free text Trigger
HIDDEN Lets only an agent start the workflow. A shopper’s message can’t. Used for workflows the AI Shopping Assistant calls itself, such as the identity check chosen under Shopper authentication for Order & Returns Management Checked or cleared Cleared
Keywords Words or phrases that start the workflow. Press Enter after each one to add it as a chip Words or phrases, such as refund, return or cancel None

Settings for Shopper authentication are on Advanced settings.

The Blocks tab lists these blocks in this order.

Block What it does
Form Asks the shopper for details, one field at a time
Condition Splits the workflow into a TRUE lane and a FALSE lane
Zendesk Opens a Zendesk ticket
Freshdesk Opens a Freshdesk ticket
Gorgias Opens a Gorgias ticket
Webhook Sends an HTTP request to another system
Message Shows the shopper a message
Delay Waits before the next block runs
LLM Asks an AI model to answer a prompt. The answer goes to later blocks, not to the shopper
Zendesk Live Agent Hands the chat to a person in Zendesk
Suspend visitor Blocks the visitor and ends the workflow
End Ends the workflow. It must be the last block

The Form block collects details from the shopper. Fields are asked in the order they appear in the block.

Field What it does Allowed values Default
Title Names the block on the canvas Free text Collect info
Message Optional text that explains what the form is for Free text. Type / to insert a value Empty
Fields The details to collect. Each row has a name, a type and a REQ toggle Any number of fields A name field and an email field, both required
Field type What kind of answer the field accepts Text, Email, Phone, Number, Long text, Dropdown, Radio, checkbox, Password Text for a new field
REQ Makes the field required On or off Off for a new field
Options The choices offered A list of values. Shown for Dropdown, Radio and checkbox None
+ Add Field Adds a field to the end of the list Not applicable Not applicable

A Password field hides what the shopper types. The chat shows the answer as dots.

The Condition block checks something and sends the workflow down one of two lanes. Each lane holds its own blocks. The lanes join again below the block.

Field What it does Allowed values Default
Title Names the block on the canvas Free text Condition
How is this decided? Chooses how the condition is written Natural language, Rules, Python code Natural language
Expression The condition in plain English, turned into a check when you save Free text. Type / to insert a value Empty
Rules Rows of field, operator and value, joined with + AND or + OR is, is not, contains, does not contain, greater than, greater than or equal, less than, less than or equal, is empty, is not empty None
Python The condition as Python code Python Empty
Behavior Detail
Lanes The TRUE lane runs when the condition is met. The FALSE lane runs when it isn’t
Placement Top level only. A Condition block can’t sit inside another one’s lane
Blank condition Evaluates as FALSE

The Zendesk, Freshdesk and Gorgias blocks open a ticket in a connected helpdesk. Each one starts on a Setup tab with an app card that shows whether the helpdesk is connected, with Connect or Update.

The fields below are for the Create Ticket action event.

Field Blocks What it does Allowed values Default
Requester email All three The shopper’s email. The helpdesk creates the contact if it doesn’t exist. Required An email. Type / to insert one Empty
Subject All three The ticket subject. Required Free text. Type / to insert a value Empty
Body All three The ticket description. Required Free text. Type / to insert a value Empty
Queue Zendesk The Zendesk group the ticket goes to A group name or ID Empty
Queue / group (optional) Freshdesk, Gorgias The group the ticket goes to, in place of the Group ID on the connection A numeric group ID Empty
Priority All three The ticket priority Low, Normal, High, Urgent Normal
Assignee Zendesk The agent the ticket is assigned to An agent’s email or ID Empty
Assignee (optional) Freshdesk, Gorgias The agent the ticket is assigned to A numeric agent ID Empty
Tags Gorgias Tags added to the ticket Comma-separated tags. Type / to insert a value Empty

The block outputs the new ticket’s ID as ticket_id. Later blocks can insert it with /, for example in a Message block that confirms the ticket to the shopper.

The Webhook block sends an HTTP request and makes the response available to later blocks. Values you type into this block, including credentials, are saved with the workflow.

Field What it does Allowed values Default
Method The HTTP method GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS GET
URL The address the request goes to A URL. Type / to insert a value Empty
Query string params Key and value pairs added to the URL Any keys and values None
Headers Key and value pairs sent as request headers Any keys and values None
Authentication Type How the request authenticates None, Basic auth (username & password), Bearer token, API key None
Payload type The body format No payload, Json, Form, Raw No payload
Sample response Runs the request from the Test tab with Run and shows the response Not applicable Empty
Timeout (seconds) How long to wait for a response 1 to 120 10
Attempts How many times to try. Retries on connection errors, 429 and 5xx responses. 1 means no retry 1 to 5 3
FOLLOW REDIRECTS Follows redirects in the response Checked or cleared Checked
CONTINUE ON ERROR Lets the workflow carry on when the request fails, so a later Condition block can check the result Checked or cleared Cleared

The LLM block sends a prompt to an AI model and makes the answer available to later blocks. The answer isn’t shown to the shopper. To send it, insert it with / in a Message block after this one.

Field What it does Allowed values Default
Title Names the block on the canvas Free text LLM
Provider Chooses who runs the model. Agent default uses the model set for custom workflows in Advanced settings Agent default or a provider from the list Agent default
Model The model to use. Shown once you choose a Provider The provider’s models The provider’s first model
System prompt Optional. Sets the model’s role and rules Free text. Type / to insert a value Empty
Prompt What the model is asked. A block with no prompt ends the workflow with an error Free text. Type / to insert a value Empty
Format The form of the answer Text, JSON Text
Example answer The JSON you expect back. Shown for JSON. The model is asked to match its shape, and its keys become values later blocks can insert with / JSON Empty
Temperature Lower is more consistent 0 to 2, or blank for the model’s default Blank
Max tokens The longest answer allowed Up to 8,000, or blank for 1,000 Blank
CONTINUE ON ERROR Lets the workflow carry on when the call fails or a JSON answer isn’t valid JSON, so a later Condition block can check the result Checked or cleared Cleared
Block Field What it does Allowed values Default
Message Message The text shown to the shopper Free text. Type / to insert a value Empty
Delay Wait for (seconds) How long to wait before the next block Up to 60 5
End Title Names the block. The block reads “This block ends the workflow. No further blocks run.” Free text End

The Suspend visitor block blocks the visitor’s IP address and ends the workflow. A block can be lifted early under Security > Blocked IPs.

Field What it does Allowed values Default
Block for How long the visitor stays blocked: a number and a unit, Minutes, Hours or Days. Until lifted holds the block until someone lifts it under Security > Blocked IPs 1 minute to 365 days, or Until lifted 60 Minutes
Reason Chooses the standard message when Message is blank Policy violation, Abuse, Spam, Fraud Policy violation
Message Shown to the visitor now and on every blocked message afterwards Free text, or blank for the standard message Blank

The Zendesk Live Agent block hands the conversation to a person in Zendesk. It uses the Zendesk Live connection, which is separate from the Zendesk ticket connection. Live chat handoff works with Zendesk only.

On the Setup tab, the Action event field is Live Chat With Agent by default. The fields below are for that action event.

Field What it does Allowed values Default
Title Names the block on the canvas Free text Zendesk Live Agent
Queue Passed to Zendesk as a label. It doesn’t route the chat to a group Free text. Type / to insert a value Empty
Note for agent Context shown to the Zendesk agent Free text. Type / to insert a value Empty
Customer email The shopper’s email An email. Type / to insert one Empty
Customer name The shopper’s name Free text. Type / to insert a value Empty
Wait for an agent (seconds) How long to wait for someone in Zendesk to accept 30 or more 300
End chat after inactivity (seconds) How long the chat can sit idle before it ends 60 or more 300
Stage What happens
Handoff starts The shopper sees a message that a member of your team will join in a moment
Agent accepts The Zendesk agent sees the Note for agent and the last 6 messages of the conversation. Messages then pass both ways
Chat ends The shopper says bye or asks to end the chat, the Zendesk agent closes it or the chat goes idle for the inactivity time
Nobody accepts After Wait for an agent (seconds), the shopper is told nobody is available
After the chat The workflow continues with the next block
Situation What happens
Starting The AI Shopping Assistant starts a workflow when a shopper’s message contains one of its keywords or a direct synonym. A message on the same general topic doesn’t start it
Skipped workflows Workflows with Status off are skipped. Hidden workflows are skipped too
While running Every message goes to the workflow until it ends. A message the shopper types in the chat fills the next missing required form field
Canceling Typing cancel, stop, exit, quit, nevermind, never mind, abort or /cancel ends the workflow. The AI Shopping Assistant confirms that it canceled
Ending A workflow ends at an End block, at a block with nothing after it, at a Suspend visitor block or on an error
Errors A timeout, a ticket that fails, a webhook that fails or an LLM call that fails ends the workflow. CONTINUE ON ERROR on a Webhook or LLM block lets it carry on

Helpdesks are connected on the Integrations page, opened from the account menu. Each card shows Connect or Update connection and a Connected badge once the console has verified the credentials. Each connection page has Disconnect, which asks you to type “disconnect” to confirm.

Connection Fields Used by
Zendesk Subdomain, Email, API token and Group ID. Group ID is required and numeric. Tickets route to that group Zendesk block
Zendesk Live App ID, Key ID and Secret key, from Zendesk Admin Center > Apps and integrations > Conversations API. Needs a Zendesk Suite plan with messaging turned on Zendesk Live Agent block
Freshdesk Subdomain, API key and an optional Group ID Freshdesk block
Gorgias Subdomain, Email, API key, an optional Support email and an optional Group ID. Support email is the address customers see on ticket replies. Left blank, it uses the account email Gorgias block
Limit Value
Workflows per page in the list 10
Delay wait Up to 60 seconds
Webhook timeout 1 to 120 seconds
Webhook attempts 1 to 5
LLM answer length Up to 8,000 tokens. 1,000 when Max tokens is blank
LLM Temperature 0 to 2
Suspend visitor block length 1 minute to 365 days, or Until lifted
Wait for an agent (seconds) 30 or more
End chat after inactivity (seconds) 60 or more
Messages the Zendesk agent sees at handoff The last 6, plus the Note for agent
Condition blocks Top level only. No conditions inside a lane
Live chat handoff Zendesk only

Frequently asked questions

Why doesn't my custom workflow start?
Check that the workflow's Status is on and that HIDDEN is cleared. The shopper's message must contain a keyword from the Trigger block or a direct synonym of one. A message on the same general topic doesn't start the workflow.
Can a shopper leave a custom workflow partway through?
Yes. A shopper who types cancel, stop, exit, quit, nevermind, never mind, abort or /cancel ends the workflow. The AI Shopping Assistant confirms that it canceled the workflow.
Which helpdesks can a custom workflow send to?
Zendesk, Freshdesk and Gorgias can each receive new tickets from a custom workflow. Only Zendesk supports a live chat handoff to a person, through the Zendesk Live Agent block and a separate Zendesk Live connection.