External DocumentationTo learn more, visit the Rootly documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Alert ID | The ID of the alert. |
| Alert Urgency ID | The ID of the alert urgency to assign to the alert. |
| Description | The description of the alert. |
| Group IDs | A comma-separated list of the group IDs to attach to the alert. |
| Noise | Select whether the alert is marked as noise. |
| Service IDs | A comma-separated list of the service IDs to attach to the alert. |
| Summary | The summary of the alert. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Alert Field Values | The custom alert field values to set on the alert. For example: |
| Data | The additional data to attach to the alert, as a JSON object. |
| Deduplication Key | The deduplication key of the alert. Alerts sharing the same deduplication key are treated as a single alert. |
| Ended At | The date and time the alert ended at. |
| Environment IDs | A comma-separated list of the environment IDs to attach to the alert. |
| External ID | The ID of the alert in the external system it originated from. |
| External URL | The URL of the alert in the external system it originated from. |
| Functionality IDs | A comma-separated list of the functionality IDs to attach to the alert. |
| Labels | The labels to attach to the alert, as a list of key-value objects. For example: |
| Started At | The date and time the alert started at. |
Example Output
{
"data": {
"id": "<string>",
"type": "alerts",
"attributes": {
"short_id": "<string>",
"source": "<string>",
"summary": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"noise": "noise",
"status": "open",
"description": "<string>",
"services": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"managed_by": "web",
"description": "<string>",
"public_description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"backstage_id": "<string>",
"external_id": "<string>",
"pagerduty_id": "<string>",
"opsgenie_id": "<string>",
"cortex_id": "<string>",
"service_now_ci_sys_id": "<string>",
"github_repository_name": "<string>",
"github_repository_branch": "<string>",
"gitlab_repository_name": "<string>",
"gitlab_repository_branch": "<string>",
"kubernetes_deployment_name": "<string>",
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"owner_group_ids": [
"<string>"
],
"owner_user_ids": [
123
],
"alert_urgency_id": "<string>",
"escalation_policy_id": "<string>",
"alerts_email_enabled": true,
"alerts_email_address": "<string>",
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"incident_broadcast_enabled": true,
"incident_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"properties": [
{
"catalog_property_id": "<string>",
"value": "<string>"
}
]
}
],
"groups": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"managed_by": "web",
"description": "<string>",
"public_description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"backstage_id": "<string>",
"external_id": "<string>",
"pagerduty_id": "<string>",
"pagerduty_service_id": "<string>",
"opsgenie_id": "<string>",
"victor_ops_id": "<string>",
"pagertree_id": "<string>",
"cortex_id": "<string>",
"service_now_ci_sys_id": "<string>",
"user_ids": [
123
],
"admin_ids": [
123
],
"alerts_email_enabled": true,
"alerts_email_address": "<string>",
"alert_urgency_id": "<string>",
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"incident_broadcast_enabled": true,
"incident_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"auto_add_members_when_attached": true,
"auto_add_members_scope": "off",
"properties": [
{
"catalog_property_id": "<string>",
"value": "<string>"
}
]
}
],
"functionalities": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"managed_by": "web",
"description": "<string>",
"public_description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"backstage_id": "<string>",
"external_id": "<string>",
"pagerduty_id": "<string>",
"opsgenie_id": "<string>",
"opsgenie_team_id": "<string>",
"cortex_id": "<string>",
"service_now_ci_sys_id": "<string>",
"position": 123,
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"owner_group_ids": [
"<string>"
],
"owner_user_ids": [
123
],
"escalation_policy_id": "<string>",
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"properties": [
{
"catalog_property_id": "<string>",
"value": "<string>"
}
]
}
],
"environments": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"managed_by": "web",
"external_id": "<string>",
"description": "<string>",
"public_description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"properties": [
{
"catalog_property_id": "<string>",
"value": "<string>"
}
]
}
],
"service_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"functionality_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"external_id": "<string>",
"external_url": "<string>",
"alert_urgency_id": "<string>",
"alert_urgency": {
"name": "<string>",
"description": "<string>",
"position": 123,
"created_at": "<string>",
"updated_at": "<string>",
"id": "<string>",
"retrigger_timeout_minutes": 123,
"urgency": "<string>",
"color": "<string>",
"team_id": 123,
"deleted_at": "<string>"
},
"group_leader_alert_id": "<string>",
"is_group_leader_alert": true,
"labels": [
{
"key": "<string>",
"value": "<string>"
}
],
"data": {},
"notification_target_type": "User",
"notification_target_id": "<string>",
"deduplication_key": "<string>",
"alert_field_values": [
{
"id": "<string>",
"value": "<string>",
"alert_field_id": "<string>",
"alert_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"responders": [
{
"id": 123,
"email": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"name": "<string>",
"phone": "<string>",
"phone_2": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"preferred_name": "<string>",
"full_name": "<string>",
"full_name_with_team": "<string>",
"slack_id": "<string>",
"time_zone": "<string>"
}
],
"notified_users": [
{
"email": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"full_name_with_team": "<string>",
"time_zone": "<string>"
}
],
"alerting_targets": [
{
"id": "<string>",
"type": "<string>"
}
],
"url": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z"
},
"source": "<string>"
},
"included": [
{
"id": "<string>",
"type": "<string>",
"attributes": {},
"relationships": {}
}
]
}