Triggered by API
Origin: This trigger event requires the use of proactive chat with the CXone Mobile SDK. Contact your CXone Account Representative for more information.
This trigger fires when an API call is made.
Create This Trigger
- Click the app selector and select ACD.
-
Go to Digital > Automation Triggers.
-
Click Add trigger.
- Enter a Name for the trigger. Since you can assign multiple jobs to the same trigger, use a name based on the event or conditions rather than an associated job.
-
From the Event drop-down, select Triggered by API.
-
From the Data Type drop-down, select if the trigger will apply to Cases, Messages, End User, Chat Window, or Visitor Destination. This changes the conditions that are available for this trigger. See the sections below for details.
- In the Delayed execution field, enter the number of seconds that Digital Experience should wait after the selected event occurs before firing the trigger. If you want it to happen immediately, enter 0.
- If you have folders that organize your triggers, you can select which folder to put this trigger in from the Folder drop-down.
- Click Save.
- From the detail page, click Activate when your trigger is completely configured.
Add a Condition
If you entered a value in the Delayed execution field when you created a trigger, make sure your condition configurations do not exceed that time. For example, if you set the Delayed execution time to 86400 seconds, or 24 hours, you cannot add a Contact status update time condition with a time period greater than 1 day.
- From the detail page, click Add Condition.
- Use the drop-down to select the condition you want. Refer to the table below for a list of conditions available for what you just created.
- Click Select.
- Some conditions require additional configuration. Refer to the table below for instructions.
Available Conditions: Cases
If the Data Type drop-down is set to Cases, the following triggers are available.
Condition Type | Details and Instructions |
---|---|
Contact direction |
Execute jobs according to whether the case is inbound or outbound. Inbound is when the contact initiates the interaction. Outbound is when the agent or system initiates the interaction.
|
Contact inbox assignee |
Execute jobs if the case is assigned to the specified member of your team.
|
Contact status |
Execute jobs if the contact has any of the selected statuses.
|
Contact status update time |
Execute jobs if the time when the case status was updated fits into the defined timeframe.
|
Contact time in routing queue |
Execute jobs based on how long a contact has been in the queue waiting to be assigned to an agent. Can be used with jobs to assign the contact to a different queue after a specified amount of time.
|
Contact waiting time |
Execute jobs if the contact has been waiting without an agent response for the defined length of time.
|
Chat Is Active |
Execute jobs if the chat window displays an online status.
|
Count of inbound messages in the contact |
Execute jobs if the number of inbound messages in the case matches the set criteria.
|
Count of outbound messages in the contact |
Execute jobs if the number of outbound messages in the case matches the set criteria.
|
Current contact assignment |
Execute jobs based on if the case is assigned to an agent or if it's still waiting in the queue.
|
Custom condition |
Execute jobs based on the response from the specified URL endpoint. The response from the endpoint should return boolean (true or false). This condition works for contact center triggers, proactive triggers, and schedulers.
|
Custom script |
Execute jobs based on the script you write in Primi language. This condition works for contact center triggers, proactive triggers, and schedulers. |
Date and time |
Executes jobs during or outside of specified time frames.
Jobs can process up to 500 contacts at a time. If you need to process more, have the job run more than once per day at different times. |
Exclude based on Post IDs |
Executes jobs excluding all cases that originate from a specific post ID. This is useful to filter out comments on a post that you want to route to a different queue.
|
Excluded tags condition |
Executes jobs based on tags on cases. Any case that does not have the tags you specify triggers the job.
|
Excluded visitor tags condition |
Executes jobs based on tags on contacts. Any contact that does not have the tags you specify triggers the job.
|
Include based on Post IDs |
Executes jobs based on a specified post ID. In this case, any case that includes at least one specified post ID is included.
|
Included channels condition |
Checks whether the chat window that is on the website belongs to specific channel. This trigger works for both contact center triggers and proactive triggers.
|
Included tags condition |
Executes jobs based on tags on cases. Any case that has the tags you specify triggers the job.
|
Included visitor tags condition |
Executes jobs based on tags on visitors. Any visitor that has the tags you specify triggers the job.
|
Last message sent |
Executes jobs based on the direction of the last message and how long ago it was sent. You can set this up to look at only the last message from the contact (inbound), only the last message from the agent (outbound), or both.
|
Proactive action grace period |
Executes jobs based on the last time a proactive action was used. Any jobs in this workflow that would be run during this time frame are skipped. The maximum grace period for proactive actions is 30 days.
|
Probability of Execution |
Executes jobs based on a probability percentage. This condition works for contact center triggers, proactive triggers, and schedulers.
|
Routing queue limit |
Executes jobs based on the size of the routing queue.
|
Routing queues |
Executes jobs based on the routing queue.
|
Satisfaction Survey Grace Period |
Executes jobs based on the last time a satisfaction survey was sent. Any jobs in this workflow that would be run during this time frame are skipped.
|
Time in queue |
Executes jobs based on the average time contacts have spent in a specific queue over a time frame you specify.
|
Available Conditions: Messages
If the Data Type drop-down is set to Messages, the following triggers are available.
Condition Type | Details and Instructions |
---|---|
Contact direction |
Execute jobs according to whether the case is inbound or outbound. Inbound is when the contact initiates the interaction. Outbound is when the agent or system initiates the interaction.
|
Contact inbox assignee |
Execute jobs if the case is assigned to the specified member of your team.
|
Contact status |
Execute jobs if the contact has any of the selected statuses.
|
Contact status update time |
Execute jobs if the time when the case status was updated fits into the defined timeframe.
|
Contact time in routing queue |
Execute jobs based on how long a contact has been in the queue waiting to be assigned to an agent. Can be used with jobs to assign the contact to a different queue after a specified amount of time.
|
Contact waiting time |
Execute jobs if the contact has been waiting without an agent response for the defined length of time.
|
Chat Is Active |
Execute jobs if the chat window displays an online status.
|
Content contains |
Execute jobs based on the content of a message. By default, it will look for matches to whatever you enter.
|
Count of inbound messages in the contact |
Execute jobs if the number of inbound messages in the case matches the set criteria.
|
Count of outbound messages in the contact |
Execute jobs if the number of outbound messages in the case matches the set criteria.
|
Current contact assignment |
Execute jobs based on if the case is assigned to an agent or if it's still waiting in the queue.
|
Custom condition |
Execute jobs based on the response from the specified URL endpoint. The response from the endpoint should return boolean (true or false). This condition works for contact center triggers, proactive triggers, and schedulers.
|
Custom script |
Execute jobs based on the script you write in Primi language. This condition works for contact center triggers, proactive triggers, and schedulers. |
Date and time |
Executes jobs during or outside of specified time frames.
Jobs can process up to 500 contacts at a time. If you need to process more, have the job run more than once per day at different times. |
Exclude based on Post IDs |
Executes jobs excluding all cases that originate from a specific post ID. This is useful to filter out comments on a post that you want to route to a different queue.
|
Excluded message subjects rule |
Executes a job based on subject. In this case, any subject that does not include what you specify triggers the job.
|
Excluded message tags condition |
Executes a job based on tags attached to the message. In this case, any message that does not have the tags you specify triggers the job.
|
Excluded tags condition |
Executes jobs based on tags on cases. Any case that does not have the tags you specify triggers the job.
|
Excluded visitor tags condition |
Executes jobs based on tags on contacts. Any contact that does not have the tags you specify triggers the job.
|
Include based on Post IDs |
Executes jobs based on a specified post ID. In this case, any case that includes at least one specified post ID is included.
|
Included channels condition |
Checks whether the chat window that is on the website belongs to specific channel. This trigger works for both contact center triggers and proactive triggers.
|
Included message sentiments rule |
Executes a job based on sentiment. In this case, any message that is marked with the sentiments you specify triggers the job.
|
Included message subjects rule |
Executes a job based on subject. In this case, any subject that includes the specified values triggers the job.
|
Included message tags condition |
Executes a job based on tags attached to the message. In this case, any message that has the tags you specify triggers the job.
|
Included tags condition |
Executes jobs based on tags on cases. Any case that has the tags you specify triggers the job.
|
Included visitor tags condition |
Executes jobs based on tags on visitors. Any visitor that has the tags you specify triggers the job.
|
Last message sent |
Executes jobs based on the direction of the last message and how long ago it was sent. You can set this up to look at only the last message from the contact (inbound), only the last message from the agent (outbound), or both.
|
Message created time |
Executes jobs based on when the message was created.
|
Message direction |
Execute jobs according to whether the message is inbound or outbound.
|
Message reply |
Executes jobs based on whether an inbound message has been replied to.
|
Proactive action grace period |
Executes jobs based on the last time a proactive action was used. Any jobs in this workflow that would be run during this time frame are skipped. The maximum grace period for proactive actions is 30 days.
|
Probability of Execution |
Executes jobs based on a probability percentage. This condition works for contact center triggers, proactive triggers, and schedulers.
|
Routing queue limit |
Executes jobs based on the size of the routing queue.
|
Routing queues |
Executes jobs based on the routing queue.
|
Satisfaction Survey Grace Period |
Executes jobs based on the last time a satisfaction survey was sent. Any jobs in this workflow that would be run during this time frame are skipped.
|
Time in queue |
Executes jobs based on the average time contacts have spent in a specific queue over a time frame you specify.
|
Available Conditions: End User
If the Data Type drop-down is set to End User, the following triggers are available.
Condition Type | Details and Instructions |
---|---|
Custom condition |
Execute jobs based on the response from the specified URL endpoint. The response from the endpoint should return boolean (true or false). This condition works for contact center triggers, proactive triggers, and schedulers.
|
Custom script |
Execute jobs based on the script you write in Primi language. This condition works for contact center triggers, proactive triggers, and schedulers. |
Date and time |
Executes jobs during or outside of specified time frames.
Jobs can process up to 500 contacts at a time. If you need to process more, have the job run more than once per day at different times. |
End user last modified time |
Execute jobs if it has been a defined timeframe since the end user last modified the case.
|
Excluded visitor tags condition |
Executes jobs based on tags on contacts. Any contact that does not have the tags you specify triggers the job.
|
Included visitor tags condition |
Executes jobs based on tags on visitors. Any visitor that has the tags you specify triggers the job.
|
Proactive action grace period |
Executes jobs based on the last time a proactive action was used. Any jobs in this workflow that would be run during this time frame are skipped. The maximum grace period for proactive actions is 30 days.
|
Probability of Execution |
Executes jobs based on a probability percentage. This condition works for contact center triggers, proactive triggers, and schedulers.
|
Time in queue |
Executes jobs based on the average time contacts have spent in a specific queue over a time frame you specify.
|
Available Conditions: Chat Window
If the Data Type drop-down is set to Chat Window, the following triggers are available.
Condition Type | Details and Instructions |
---|---|
Chat Is Active |
Execute jobs if the chat window displays an online status.
|
Custom script |
Execute jobs based on the script you write in Primi language. This condition works for contact center triggers, proactive triggers, and schedulers. |
Date and time |
Executes jobs during or outside of specified time frames.
Jobs can process up to 500 contacts at a time. If you need to process more, have the job run more than once per day at different times. |
Excluded visitor tags condition |
Executes jobs based on tags on contacts. Any contact that does not have the tags you specify triggers the job.
|
Included channels condition |
Checks whether the chat window that is on the website belongs to specific channel. This trigger works for both contact center triggers and proactive triggers.
|
Included visitor tags condition |
Executes jobs based on tags on visitors. Any visitor that has the tags you specify triggers the job.
|
Proactive action grace period |
Executes jobs based on the last time a proactive action was used. Any jobs in this workflow that would be run during this time frame are skipped. The maximum grace period for proactive actions is 30 days.
|
Probability of Execution |
Executes jobs based on a probability percentage. This condition works for contact center triggers, proactive triggers, and schedulers.
|
Available Conditions: Visitor Destination
If the Data Type drop-down is set to Visitor Destination, the following triggers are available.
Condition Type | Details and Instructions |
---|---|
Chat Is Active |
Execute jobs if the chat window displays an online status.
|
Custom condition |
Execute jobs based on the response from the specified URL endpoint. The response from the endpoint should return boolean (true or false). This condition works for contact center triggers, proactive triggers, and schedulers.
|
Date and time |
Executes jobs during or outside of specified time frames.
Jobs can process up to 500 contacts at a time. If you need to process more, have the job run more than once per day at different times. |
Excluded visitor tags condition |
Executes jobs based on tags on contacts. Any contact that does not have the tags you specify triggers the job.
|
Included channels condition |
Checks whether the chat window that is on the website belongs to specific channel. This trigger works for both contact center triggers and proactive triggers.
|
Included visitor tags condition |
Executes jobs based on tags on visitors. Any visitor that has the tags you specify triggers the job.
|
Proactive action grace period |
Executes jobs based on the last time a proactive action was used. Any jobs in this workflow that would be run during this time frame are skipped. The maximum grace period for proactive actions is 30 days.
|
Probability of Execution |
Executes jobs based on a probability percentage. This condition works for contact center triggers, proactive triggers, and schedulers.
|
Time in queue |
Executes jobs based on the average time contacts have spent in a specific queue over a time frame you specify.
|
Add a Job
-
From the detail page, click either Add new job or Add existing job, depending on if the job you want already exists.
- If you clicked Add new job, follow the steps to create the job you want. These steps can be found on the individual help page for that job, located in the menu on the left of this page.
- If you clicked Add existing job:
- Use the drop-down to select the job you want.
- Click Add.