Creates an alert

Overview

Overview

Reference

AlertEvents
AlertGroups
AlertUrgencies
AlertSources
Alerts
- GET
  List Incident alerts
- POST
  Attach alerts to an incident
- GET
  List alerts
- POST
  Creates an alert
- GET
  Retrieves an alert
- POST
  Acknowledges an alert
- POST
  Resolves an alert
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
Causes
[DEPRECATED] CustomFieldOptions
[DEPRECATED] CustomFields
CustomForms
DashboardPanels
Dashboards
Environments
EscalationPolicies
EscalationLevelsPolicies
EscalationLevelsPath
EscalationLevels
EscalationPaths
FormFieldOptions
FormFieldPlacementConditions
FormFieldPlacements
FormFieldPositions
FormFields
FormSetConditions
FormSets
Functionalities
WorkflowTasks
[DEPRECATED] WorkflowCustomFieldSelections
WorkflowFormFieldConditions
WorkflowGroups
WorkflowRuns
Workflows
Heartbeats
IncidentActionItems
[DEPRECATED] IncidentCustomFieldSelections
IncidentEventFunctionalities
IncidentEventServices
IncidentEvents
IncidentFeedbacks
IncidentFormFieldSelections
IncidentPermissionSetBooleans
IncidentPermissionSetResources
IncidentPermissionSets
IncidentRetrospectives
IncidentRetrospectiveSteps
IncidentRoleTasks
IncidentRoles
IncidentStatusPageEvents
IncidentSubStatuses
IncidentTypes
Incidents
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
Pulses
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
Roles
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Shifts
Secrets
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
Users
WebhooksDeliveries
WebhooksEndpoints

POST

alerts

curl --request POST \
  --url https://api.rootly.com/v1/alerts \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/vnd.api+json'

{
  "data": {
    "id": "531ee60f-d7c4-4e91-9354-8cfcfd7872e2",
    "type": "alerts",
    "attributes": {
      "short_id": null,
      "source": "asana",
      "status": "open",
      "summary": "Asana ticket created",
      "description": null,
      "labels": [
        {
          "key": "status",
          "value": "succeeded"
        }
      ],
      "services": [
        {
          "id": "4d5a0754-58c2-4a2a-b9de-91c5723ee721",
          "team_id": 15,
          "name": "Iste et facere error.",
          "slug": "iste-et-facere-error",
          "description": "Officiis numquam odio iure.",
          "deleted_at": null,
          "created_at": "2025-03-13T11:58:55.756-07:00",
          "updated_at": "2025-03-13T11:58:55.756-07:00",
          "opsgenie_id": null,
          "pagerduty_id": null,
          "public_description": null,
          "github_repository_branch": "master",
          "github_repository_name": null,
          "color": "#D7E7F5",
          "heroku_app_name": null,
          "gitlab_repository_name": null,
          "gitlab_repository_branch": "master",
          "kubernetes_deployment_name": null,
          "incidents_count": 0,
          "position": 1,
          "slack_channels": [],
          "slack_aliases": [],
          "backstage_id": null,
          "show_uptime": true,
          "show_uptime_last_days": 60,
          "status": "operational",
          "external_id": null,
          "notify_emails": [],
          "cortex_id": null,
          "alerts_email_enabled": false,
          "alerts_email_address": "service-f4265f9719b02266f7305fe7cce31341@email.rootly.com",
          "opsgenie_team_id": null,
          "service_now_ci_sys_id": null,
          "alert_urgency_id": null,
          "opslevel_id": null
        }
      ],
      "groups": [],
      "environments": [
        {
          "id": "20581f98-72a3-4fbb-b51f-a745b2a6c3e7",
          "team_id": 15,
          "name": "Aut eos placeat consequatur.",
          "slug": "aut-eos-placeat-consequatur",
          "description": "Impedit iusto iste quis.",
          "color": "#090924",
          "deleted_at": null,
          "created_at": "2025-03-13T11:58:55.793-07:00",
          "updated_at": "2025-03-13T11:58:55.793-07:00",
          "incidents_count": 0,
          "position": 1,
          "slack_channels": [],
          "slack_aliases": [],
          "external_id": null,
          "notify_emails": []
        }
      ],
      "responders": [],
      "incidents": [],
      "data": {
        "url": "https://asana.com/issues/1"
      },
      "started_at": "2025-03-13T11:56:27.000-07:00",
      "ended_at": "2025-03-13T11:58:27.000-07:00",
      "external_id": null,
      "external_url": null,
      "url": "https://test.rootly.com/account/alerts/531ee60f-d7c4-4e91-9354-8cfcfd7872e2",
      "notification_target_type": null,
      "notification_target_id": null,
      "alert_urgency_id": "7e24446f-0ca5-413d-a751-8eecebb8ac45",
      "notified_users": [],
      "created_at": "2025-03-13T11:58:58.339-07:00",
      "updated_at": "2025-03-13T11:58:58.339-07:00"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json

data

object

required

data.type

enum<string>

required

Available options:

alerts

data.attributes

object

required

data.attributes.source

enum<string>

required

The source of the alert

Available options:

rootly,

manual,

web,

slack,

email,

workflow,

live_call_routing,

email,

pagerduty,

opsgenie,

victorops,

pagertree,

datadog,

nobl9,

zendesk,

asana,

clickup,

sentry,

rollbar,

jira,

honeycomb,

service_now,

linear,

grafana,

alertmanager,

google_cloud,

generic_webhook,

cloud_watch,

azure,

splunk,

chronosphere,

app_optics,

bug_snag,

monte_carlo,

nagios,

prtg,

catchpoint,

app_dynamics

data.attributes.summary

string

required

The summary of the alert

data.attributes.noise

enum<string> | null

Whether the alert is marked as noise

Available options:

noise,

not_noise

data.attributes.status

enum<string>

Only available for organizations with Rootly On-Call enabled. Can be one of open, triggered, acknowledged or resolved.

Available options:

open,

triggered

data.attributes.description

string | null

The description of the alert

data.attributes.service_ids

string[] | null

The Service ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you.

data.attributes.group_ids

string[] | null

The Group ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you.

data.attributes.environment_ids

string[] | null

The Environment ID's to attach to the alert

data.attributes.started_at

string | null

Alert start datetime

data.attributes.ended_at

string | null

Alert end datetime

data.attributes.external_id

string | null

External ID

data.attributes.external_url

string | null

External Url

data.attributes.alert_urgency_id

string | null

The ID of the alert urgency

data.attributes.notification_target_type

enum<string> | null

Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, User.

Available options:

User,

Group,

EscalationPolicy,

Service

data.attributes.notification_target_id

string | null

Only available for organizations with Rootly On-Call enabled. The identifier of the notification target object.

data.attributes.labels

array

data.attributes.data

object | null

Additional data

Response

201

application/vnd.api+json

alert created

data

object

required

data.id

string

required

Unique ID of the alert

data.type

enum<string>

required

Available options:

alerts

data.attributes

object

required

data.attributes.source

enum<string>

required

The source of the alert

Available options:

rootly,

manual,

web,

slack,

email,

workflow,

live_call_routing,

email,

pagerduty,

opsgenie,

victorops,

pagertree,

datadog,

nobl9,

zendesk,

asana,

clickup,

sentry,

rollbar,

jira,

honeycomb,

service_now,

linear,

grafana,

alertmanager,

google_cloud,

generic_webhook,

cloud_watch,

azure,

splunk,

chronosphere,

app_optics,

bug_snag,

monte_carlo,

nagios,

prtg,

catchpoint,

app_dynamics

data.attributes.summary

string

required

The summary of the alert

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.noise

enum<string> | null

Whether the alert is marked as noise

Available options:

noise,

not_noise

data.attributes.status

enum<string>

The status of the alert

Available options:

open,

triggered,

acknowledged,

resolved

data.attributes.description

string | null

The description of the alert

data.attributes.services

object[]

Services attached to the alert

data.attributes.services.name

string

required

The name of the service

data.attributes.services.created_at

string

required

Date of creation

data.attributes.services.updated_at

string

required

Date of last update

data.attributes.services.slug

string

The slug of the service

data.attributes.services.description

string | null

The description of the service

data.attributes.services.public_description

string | null

The public description of the service

data.attributes.services.notify_emails

string[] | null

Emails attached to the service

data.attributes.services.color

string | null

The hex color of the service

data.attributes.services.position

integer | null

Position of the service

data.attributes.services.backstage_id

string | null

The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name

data.attributes.services.external_id

string | null

The external id associated to this service

data.attributes.services.pagerduty_id

string | null

The PagerDuty service id associated to this service

data.attributes.services.opsgenie_id

string | null

The Opsgenie service id associated to this service

data.attributes.services.cortex_id

string | null

The Cortex group id associated to this service

data.attributes.services.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this service

data.attributes.services.github_repository_name

string | null

The GitHub repository name associated to this service. eg: rootlyhq/my-service

data.attributes.services.github_repository_branch

string | null

The GitHub repository branch associated to this service. eg: main

data.attributes.services.gitlab_repository_name

string | null

The GitLab repository name associated to this service. eg: rootlyhq/my-service

data.attributes.services.gitlab_repository_branch

string | null

The GitLab repository branch associated to this service. eg: main

data.attributes.services.environment_ids

string[] | null

Environments associated with this service

data.attributes.services.service_ids

string[] | null

Services dependent on this service

data.attributes.services.owners_group_ids

string[] | null

Owner Teams associated with this service

data.attributes.services.owners_user_ids

integer[] | null

Owner Users associated with this service

data.attributes.services.alert_urgency_id

string | null

The alert urgency id of the service

data.attributes.services.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.services.alerts_email_address

string | null

Email generated to send alerts to

data.attributes.services.slack_channels

object[] | null

Slack Channels associated with this service

data.attributes.services.slack_aliases

object[] | null

Slack Aliases associated with this service

data.attributes.groups

object[]

Groups attached to the alert

data.attributes.groups.name

string

required

The name of the team

data.attributes.groups.created_at

string

required

Date of creation

data.attributes.groups.updated_at

string

required

Date of last update

data.attributes.groups.slug

string

data.attributes.groups.description

string | null

The description of the team

data.attributes.groups.notify_emails

string[] | null

Emails to attach to the team

data.attributes.groups.color

string | null

The hex color of the team

data.attributes.groups.position

integer | null

Position of the team

data.attributes.groups.backstage_id

string | null

The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name

data.attributes.groups.external_id

string | null

The external id associated to this team

data.attributes.groups.pagerduty_id

string | null

The PagerDuty group id associated to this team

data.attributes.groups.pagerduty_service_id

string | null

The PagerDuty service id associated to this team

data.attributes.groups.opsgenie_id

string | null

The Opsgenie group id associated to this team

data.attributes.groups.victor_ops_id

string | null

The VictorOps group id associated to this team

data.attributes.groups.pagertree_id

string | null

The PagerTree group id associated to this team

data.attributes.groups.cortex_id

string | null

The Cortex group id associated to this team

data.attributes.groups.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this team

data.attributes.groups.user_ids

integer[] | null

The user ids of the members of this team.

data.attributes.groups.admin_ids

integer[] | null

The user ids of the admins of this team. These users must also be present in user_ids attribute.

data.attributes.groups.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.groups.alerts_email_address

string | null

Email generated to send alerts to

data.attributes.groups.alert_urgency_id

string | null

The alert urgency id of the team

data.attributes.groups.slack_channels

object[] | null

Slack Channels associated with this team

data.attributes.groups.slack_aliases

object[] | null

Slack Aliases associated with this team

data.attributes.environments

object[]

Environments attached to the alert

data.attributes.external_id

string | null

External ID

data.attributes.external_url

string | null

External Url

data.attributes.alert_urgency_id

string | null

The ID of the alert urgency

data.attributes.labels

array

data.attributes.data

object | null

Additional data

data.source

enum<string>

The source of the alert

Available options:

rootly,

manual,

web,

slack,

email,

workflow,

live_call_routing,

email,

pagerduty,

opsgenie,

victorops,

pagertree,

datadog,

nobl9,

zendesk,

asana,

clickup,

sentry,

rollbar,

jira,

honeycomb,

service_now,

linear,

grafana,

alertmanager,

google_cloud,

generic_webhook,

cloud_watch,

azure,

splunk,

chronosphere,

app_optics,

bug_snag,

monte_carlo,

nagios,

prtg,

catchpoint,

app_dynamics

Was this page helpful?

Retrieves an alertRetrieves a specific alert by id

curl --request POST \
  --url https://api.rootly.com/v1/alerts \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/vnd.api+json'

{
  "data": {
    "id": "531ee60f-d7c4-4e91-9354-8cfcfd7872e2",
    "type": "alerts",
    "attributes": {
      "short_id": null,
      "source": "asana",
      "status": "open",
      "summary": "Asana ticket created",
      "description": null,
      "labels": [
        {
          "key": "status",
          "value": "succeeded"
        }
      ],
      "services": [
        {
          "id": "4d5a0754-58c2-4a2a-b9de-91c5723ee721",
          "team_id": 15,
          "name": "Iste et facere error.",
          "slug": "iste-et-facere-error",
          "description": "Officiis numquam odio iure.",
          "deleted_at": null,
          "created_at": "2025-03-13T11:58:55.756-07:00",
          "updated_at": "2025-03-13T11:58:55.756-07:00",
          "opsgenie_id": null,
          "pagerduty_id": null,
          "public_description": null,
          "github_repository_branch": "master",
          "github_repository_name": null,
          "color": "#D7E7F5",
          "heroku_app_name": null,
          "gitlab_repository_name": null,
          "gitlab_repository_branch": "master",
          "kubernetes_deployment_name": null,
          "incidents_count": 0,
          "position": 1,
          "slack_channels": [],
          "slack_aliases": [],
          "backstage_id": null,
          "show_uptime": true,
          "show_uptime_last_days": 60,
          "status": "operational",
          "external_id": null,
          "notify_emails": [],
          "cortex_id": null,
          "alerts_email_enabled": false,
          "alerts_email_address": "service-f4265f9719b02266f7305fe7cce31341@email.rootly.com",
          "opsgenie_team_id": null,
          "service_now_ci_sys_id": null,
          "alert_urgency_id": null,
          "opslevel_id": null
        }
      ],
      "groups": [],
      "environments": [
        {
          "id": "20581f98-72a3-4fbb-b51f-a745b2a6c3e7",
          "team_id": 15,
          "name": "Aut eos placeat consequatur.",
          "slug": "aut-eos-placeat-consequatur",
          "description": "Impedit iusto iste quis.",
          "color": "#090924",
          "deleted_at": null,
          "created_at": "2025-03-13T11:58:55.793-07:00",
          "updated_at": "2025-03-13T11:58:55.793-07:00",
          "incidents_count": 0,
          "position": 1,
          "slack_channels": [],
          "slack_aliases": [],
          "external_id": null,
          "notify_emails": []
        }
      ],
      "responders": [],
      "incidents": [],
      "data": {
        "url": "https://asana.com/issues/1"
      },
      "started_at": "2025-03-13T11:56:27.000-07:00",
      "ended_at": "2025-03-13T11:58:27.000-07:00",
      "external_id": null,
      "external_url": null,
      "url": "https://test.rootly.com/account/alerts/531ee60f-d7c4-4e91-9354-8cfcfd7872e2",
      "notification_target_type": null,
      "notification_target_id": null,
      "alert_urgency_id": "7e24446f-0ca5-413d-a751-8eecebb8ac45",
      "notified_users": [],
      "created_at": "2025-03-13T11:58:58.339-07:00",
      "updated_at": "2025-03-13T11:58:58.339-07:00"
    }
  }
}