Overview
Reference
- AlertEvents
- AlertGroups
- AlertUrgencies
- AlertSources
- Alerts
- 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
Creates an alert
Creates a new alert from provided data
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
alerts
The source of the alert
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
The summary of the alert
Whether the alert is marked as noise
noise
, not_noise
Only available for organizations with Rootly On-Call enabled. Can be one of open, triggered, acknowledged or resolved.
open
, triggered
The description of the alert
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.
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.
The Environment ID's to attach to the alert
Alert start datetime
Alert end datetime
External ID
External Url
The ID of the alert urgency
Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, User.
User
, Group
, EscalationPolicy
, Service
Only available for organizations with Rootly On-Call enabled. The identifier of the notification target object.
Additional data
Response
Unique ID of the alert
alerts
The source of the alert
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
The summary of the alert
Date of creation
Date of last update
Whether the alert is marked as noise
noise
, not_noise
The status of the alert
open
, triggered
, acknowledged
, resolved
The description of the alert
Services attached to the alert
The name of the service
Date of creation
Date of last update
The slug of the service
The description of the service
The public description of the service
Emails attached to the service
The hex color of the service
Position of the service
The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name
The external id associated to this service
The PagerDuty service id associated to this service
The Opsgenie service id associated to this service
The Cortex group id associated to this service
The Service Now CI sys id associated to this service
The GitHub repository name associated to this service. eg: rootlyhq/my-service
The GitHub repository branch associated to this service. eg: main
The GitLab repository name associated to this service. eg: rootlyhq/my-service
The GitLab repository branch associated to this service. eg: main
Environments associated with this service
Services dependent on this service
Owner Teams associated with this service
Owner Users associated with this service
The alert urgency id of the service
Enable alerts through email
Email generated to send alerts to
Groups attached to the alert
The name of the team
Date of creation
Date of last update
The description of the team
Emails to attach to the team
The hex color of the team
Position of the team
The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name
The external id associated to this team
The PagerDuty group id associated to this team
The PagerDuty service id associated to this team
The Opsgenie group id associated to this team
The VictorOps group id associated to this team
The PagerTree group id associated to this team
The Cortex group id associated to this team
The Service Now CI sys id associated to this team
The user ids of the members of this team.
The user ids of the admins of this team. These users must also be present in user_ids attribute.
Enable alerts through email
Email generated to send alerts to
The alert urgency id of the team
Environments attached to the alert
The name of the environment
Date of creation
Date of last update
The slug of the environment
The description of the environment
Emails attached to the environment
The hex color of the environment
Position of the environment
External ID
External Url
The ID of the alert urgency
Additional data
The source of the alert
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?
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"
}
}
}