Overview
AlertEvents
AlertGroups
AlertRoutingRules
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
[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
- GETList incidents
- POSTCreates an incident
- GETRetrieves an incident
- PUTUpdate an incident
- DELDelete an incident
- PUTMitigate an incident
- PUTResolve an incident
- PUTCancel an incident
- PUTTriage an incident
- PUTRestart an incident
- PUTMark an incident as a duplicate
- POSTAdd subscribers to incident
- DELRemove subscribers from incident
- POSTAssign user to incident
- DELRemove assigned user from incident
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
WebhooksDeliveries
WorkflowRuns
Creates a workflow run
WorkflowRuns
Creates a workflow run
Creates a new workflow run from provided data
POST
/
v1
/
workflows
/
{workflow_id}
/
workflow_runs
curl --request POST \
--url https://api.rootly.com/v1/workflows/{workflow_id}/workflow_runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "workflow_runs",
"attributes": {
"immediate": true,
"check_conditions": false,
"context": {}
}
}
}'
{
"data": {
"id": "a4827cd6-01ca-4ab5-962d-71b804656059",
"type": "workflow_runs",
"attributes": {
"kind": "incident",
"status": "queued",
"status_message": null,
"triggered_by": "user",
"user_id": 168,
"queued_at": "2025-03-28T23:00:33.198-07:00",
"started_at": null,
"completed_at": null,
"failed_at": null,
"canceled_at": null,
"updated_at": "2025-03-28T23:00:33.198-07:00",
"created_at": "2025-03-28T23:00:33.198-07:00",
"incident_id": "fbc8b000-b064-41cf-90aa-55e5a83b6ed4",
"post_mortem_id": null,
"action_item_id": null,
"alert_id": null,
"pulse_id": null,
"workflow_id": "105c6969-cba8-4a3e-bba3-e7fd24b6c5e0",
"workflow_name": "Hotel Rwanda"
},
"relationships": {
"task_runs": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/vnd.api+json
Available options:
workflow_runs
If false, this will respect wait time configured on the workflow.
If true, this will check conditions. If conditions are not satisfied the run will not be created.
Response
201
application/vnd.api+json
workflow run created
Unique ID of the workflow run
Available options:
workflow_runs
Available options:
queued
, started
, completed
, completed_with_errors
, failed
, canceled
Available options:
system
, user
, workflow
Was this page helpful?
curl --request POST \
--url https://api.rootly.com/v1/workflows/{workflow_id}/workflow_runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "workflow_runs",
"attributes": {
"immediate": true,
"check_conditions": false,
"context": {}
}
}
}'
{
"data": {
"id": "a4827cd6-01ca-4ab5-962d-71b804656059",
"type": "workflow_runs",
"attributes": {
"kind": "incident",
"status": "queued",
"status_message": null,
"triggered_by": "user",
"user_id": 168,
"queued_at": "2025-03-28T23:00:33.198-07:00",
"started_at": null,
"completed_at": null,
"failed_at": null,
"canceled_at": null,
"updated_at": "2025-03-28T23:00:33.198-07:00",
"created_at": "2025-03-28T23:00:33.198-07:00",
"incident_id": "fbc8b000-b064-41cf-90aa-55e5a83b6ed4",
"post_mortem_id": null,
"action_item_id": null,
"alert_id": null,
"pulse_id": null,
"workflow_id": "105c6969-cba8-4a3e-bba3-e7fd24b6c5e0",
"workflow_name": "Hotel Rwanda"
},
"relationships": {
"task_runs": {
"data": []
}
}
}
}