Skip to content

RuleAction

Source code in docs_src/capo_connect/types/rule_action.py
class RuleAction(TypedDict, closed=True):
    action_type: "capo_connect.types.action_type.ActionType"
    """<p>The type of action that creates a rule.</p>"""
    task_action: NotRequired[
        "capo_connect.types.task_action_definition.TaskActionDefinition"
    ]
    """<p>Information about the task action. This field is required if <code>TriggerEventSource</code> is one of the following values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code> </p>"""
    event_bridge_action: NotRequired[
        "capo_connect.types.event_bridge_action_definition.EventBridgeActionDefinition"
    ]
    """<p>Information about the EventBridge action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code> | <code>OnContactEvaluationSubmit</code> | <code>OnMetricDataUpdate</code> </p>"""
    assign_contact_category_action: NotRequired[
        "capo_connect.types.assign_contact_category_action_definition.AssignContactCategoryActionDefinition"
    ]
    """<p>Information about the contact category action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code> | <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code> </p>"""
    send_notification_action: NotRequired[
        "capo_connect.types.send_notification_action_definition.SendNotificationActionDefinition"
    ]
    """<p>Information about the send notification action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code> | <code>OnContactEvaluationSubmit</code> | <code>OnMetricDataUpdate</code> </p>"""
    create_case_action: NotRequired[
        "capo_connect.types.create_case_action_definition.CreateCaseActionDefinition"
    ]
    """<p>Information about the create case action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code>.</p>"""
    update_case_action: NotRequired[
        "capo_connect.types.update_case_action_definition.UpdateCaseActionDefinition"
    ]
    """<p>Information about the update case action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseCreate</code> | <code>OnCaseUpdate</code>.</p>"""
    assign_sla_action: NotRequired[
        "capo_connect.types.assign_sla_action_definition.AssignSlaActionDefinition"
    ]
    """<p>Information about the assign SLA action.</p>"""
    end_associated_tasks_action: NotRequired[
        "capo_connect.types.end_associated_tasks_action_definition.EndAssociatedTasksActionDefinition"
    ]
    """<p>Information about the end associated tasks action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseUpdate</code>.</p>"""
    submit_auto_evaluation_action: NotRequired[
        "capo_connect.types.submit_auto_evaluation_action_definition.SubmitAutoEvaluationActionDefinition"
    ]
    """<p>Information about the submit automated evaluation action.</p>"""
    extract_information_action: NotRequired[
        "capo_connect.types.extract_information_action_definition.ExtractInformationActionDefinition"
    ]
    """<p>Information about the extract information action.</p>"""
    send_in_app_notification_action: NotRequired[
        "capo_connect.types.send_in_app_notification_action_definition.SendInAppNotificationActionDefinition"
    ]
    """<p>Information about the send in-app notification action.</p> <p>Supported only for <code>TriggerEventSource</code> values: <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> | <code>OnRealTimeChatAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code> | <code>OnAfterCallWorkAvailable</code> | <code>OnAfterChatWorkAvailable</code> | <code>OnEmailAnalysisAvailable</code> | <code>OnContactEvaluationSubmit</code> | <code>OnCaseCreate</code> | <code>OnCaseUpdate</code> | <code>OnSlaBreach</code> | <code>OnSchedulePublish</code> | <code>OnScheduleUpdate</code> | <code>OnScheduleTimeOffRequestActivity</code> </p>"""

action_type instance-attribute

action_type: ActionType

The type of action that creates a rule.

assign_contact_category_action instance-attribute

assign_contact_category_action: NotRequired[AssignContactCategoryActionDefinition]

Information about the contact category action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

assign_sla_action instance-attribute

assign_sla_action: NotRequired[AssignSlaActionDefinition]

Information about the assign SLA action.

create_case_action instance-attribute

create_case_action: NotRequired[CreateCaseActionDefinition]

Information about the create case action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.

end_associated_tasks_action instance-attribute

end_associated_tasks_action: NotRequired[EndAssociatedTasksActionDefinition]

Information about the end associated tasks action.

Supported only for TriggerEventSource values: OnCaseUpdate.

event_bridge_action instance-attribute

event_bridge_action: NotRequired[EventBridgeActionDefinition]

Information about the EventBridge action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

extract_information_action instance-attribute

extract_information_action: NotRequired[ExtractInformationActionDefinition]

Information about the extract information action.

send_in_app_notification_action instance-attribute

send_in_app_notification_action: NotRequired[SendInAppNotificationActionDefinition]

Information about the send in-app notification action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnAfterCallWorkAvailable | OnAfterChatWorkAvailable | OnEmailAnalysisAvailable | OnContactEvaluationSubmit | OnCaseCreate | OnCaseUpdate | OnSlaBreach | OnSchedulePublish | OnScheduleUpdate | OnScheduleTimeOffRequestActivity

send_notification_action instance-attribute

send_notification_action: NotRequired[SendNotificationActionDefinition]

Information about the send notification action.

Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

submit_auto_evaluation_action instance-attribute

submit_auto_evaluation_action: NotRequired[SubmitAutoEvaluationActionDefinition]

Information about the submit automated evaluation action.

task_action instance-attribute

task_action: NotRequired[TaskActionDefinition]

Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

update_case_action instance-attribute

update_case_action: NotRequired[UpdateCaseActionDefinition]

Information about the update case action.

Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.