Defines what happens when the rule triggers. Combines an action type with action-specific configuration data.
data [required]
object
Configuration for the action to execute, dependent on the action type.
agent_type
string
The type of AI agent to assign. Required when the action type is assign_agent.
assigned_agent_id
string
The identifier of the AI agent to assign to the case. Required when the action type is assign_agent.
handle
string
The handle of the Datadog workflow to execute. Required when the action type is execute_workflow.
type [required]
enum
The type of automated action to perform when the rule triggers. execute_workflow runs a Datadog workflow; assign_agent assigns an AI agent to the case.
Allowed enum values: execute_workflow,assign_agent
name [required]
string
Name of the automation rule.
state
enum
Whether the automation rule is active. Enabled rules trigger on matching case events; disabled rules are inactive but preserve their configuration.
Allowed enum values: ENABLED,DISABLED
trigger [required]
object
Defines when the rule activates. Combines a trigger type (the case event to listen for) with optional trigger data (conditions that narrow when the trigger fires).
data
object
Additional configuration for the trigger, dependent on the trigger type. For status_transitioned triggers, specify from_status_name and to_status_name. For attribute_value_changed triggers, specify field and change_type.
approval_type
string
The approval outcome to match. Used with case_review_approved triggers.
change_type
string
The kind of attribute change to match. Allowed values: VALUE_ADDED, VALUE_DELETED, ANY_CHANGES. Used with attribute_value_changed triggers.
field
string
The case attribute field name to monitor for changes. Used with attribute_value_changed triggers.
from_status_name
string
The originating status name. Used with status_transitioned triggers to match transitions from this status.
to_status_name
string
The destination status name. Used with status_transitioned triggers to match transitions to this status.
type [required]
enum
The case event that activates the automation rule.
Allowed enum values: case_created,status_transitioned,attribute_value_changed,event_correlation_signal_correlated,case_review_approved,comment_added
type [required]
enum
JSON:API resource type for case automation rules.
Allowed enum values: rule
An automation rule that executes an action (such as running a Datadog workflow or assigning an AI agent) when a specified case event occurs within a project.
attributes [required]
object
Core attributes of an automation rule, including its name, trigger condition, action to execute, and current state.
action [required]
object
Defines what happens when the rule triggers. Combines an action type with action-specific configuration data.
data [required]
object
Configuration for the action to execute, dependent on the action type.
agent_type
string
The type of AI agent to assign. Required when the action type is assign_agent.
assigned_agent_id
string
The identifier of the AI agent to assign to the case. Required when the action type is assign_agent.
handle
string
The handle of the Datadog workflow to execute. Required when the action type is execute_workflow.
type [required]
enum
The type of automated action to perform when the rule triggers. execute_workflow runs a Datadog workflow; assign_agent assigns an AI agent to the case.
Allowed enum values: execute_workflow,assign_agent
created_at [required]
date-time
Timestamp when the automation rule was created.
modified_at
date-time
Timestamp when the automation rule was last modified.
name [required]
string
A human-readable name for the automation rule, used to identify the rule in the UI and API responses.
state [required]
enum
Whether the automation rule is active. Enabled rules trigger on matching case events; disabled rules are inactive but preserve their configuration.
Allowed enum values: ENABLED,DISABLED
trigger [required]
object
Defines when the rule activates. Combines a trigger type (the case event to listen for) with optional trigger data (conditions that narrow when the trigger fires).
data
object
Additional configuration for the trigger, dependent on the trigger type. For status_transitioned triggers, specify from_status_name and to_status_name. For attribute_value_changed triggers, specify field and change_type.
approval_type
string
The approval outcome to match. Used with case_review_approved triggers.
change_type
string
The kind of attribute change to match. Allowed values: VALUE_ADDED, VALUE_DELETED, ANY_CHANGES. Used with attribute_value_changed triggers.
field
string
The case attribute field name to monitor for changes. Used with attribute_value_changed triggers.
from_status_name
string
The originating status name. Used with status_transitioned triggers to match transitions from this status.
to_status_name
string
The destination status name. Used with status_transitioned triggers to match transitions to this status.
type [required]
enum
The case event that activates the automation rule.
Allowed enum values: case_created,status_transitioned,attribute_value_changed,event_correlation_signal_correlated,case_review_approved,comment_added
id [required]
string
Automation rule identifier.
relationships
object
Related resources for the automation rule, including the users who created and last modified it.
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
type [required]
enum
JSON:API resource type for case automation rules.
Allowed enum values: rule
