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 a workflow task
Creates a new workflow task from provided data
curl --request POST \
--url https://api.rootly.com/v1/workflows/%7Bworkflow_id%7D/workflow_tasks \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'
{
"data": {
"id": "92a52c9e-3d9a-4a80-81e5-e2af44938b14",
"type": "workflow_tasks",
"attributes": {
"workflow_id": "9da6de8c-bec2-4930-b8e1-5696233dd818",
"task_params": {
"task_type": "send_email",
"from": "Rootly <no-reply@rootly.com>",
"to": [
"test@example.com"
],
"cc": [],
"bcc": [],
"subject": "Hello from Rootly",
"preheader": null,
"body": "Hello from Rootly",
"include_header": true,
"include_footer": true,
"custom_logo_url": null
},
"name": "My Custom Name",
"position": 2,
"skip_on_failure": false,
"enabled": true,
"created_at": "2025-03-05T15:07:44.285-08:00",
"updated_at": "2025-03-05T15:07:44.285-08:00"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
workflow_tasks
The action item priority
high
, medium
, low
The action item summary
The action item status
open
, in_progress
, cancelled
, done
add_action_item
Attribute of the Incident to match against
jira_issue_id
Value that attribute_to_query_by to uses to match against
The role id this action item is associated with
[DEPRECATED] Use assigned_to_user attribute instead. The user id this action item is assigned to
The action item kind
The action item description
Custom field mappings. Can contain liquid markup and need to be valid JSON
Name of the workflow task
The position of the workflow task
Skip workflow task if any failures
Enable/disable workflow task
Response
Unique ID of the workflow task
workflow_tasks
The ID of the parent workflow
The action item priority
high
, medium
, low
The action item summary
The action item status
open
, in_progress
, cancelled
, done
add_action_item
Attribute of the Incident to match against
jira_issue_id
Value that attribute_to_query_by to uses to match against
The role id this action item is associated with
[DEPRECATED] Use assigned_to_user attribute instead. The user id this action item is assigned to
The action item kind
The action item description
Custom field mappings. Can contain liquid markup and need to be valid JSON
The position of the workflow task
Skip workflow task if any failures
Enable/disable workflow task
Date of creation
Date of last update
Name of the workflow task
Was this page helpful?
curl --request POST \
--url https://api.rootly.com/v1/workflows/%7Bworkflow_id%7D/workflow_tasks \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'
{
"data": {
"id": "92a52c9e-3d9a-4a80-81e5-e2af44938b14",
"type": "workflow_tasks",
"attributes": {
"workflow_id": "9da6de8c-bec2-4930-b8e1-5696233dd818",
"task_params": {
"task_type": "send_email",
"from": "Rootly <no-reply@rootly.com>",
"to": [
"test@example.com"
],
"cc": [],
"bcc": [],
"subject": "Hello from Rootly",
"preheader": null,
"body": "Hello from Rootly",
"include_header": true,
"include_footer": true,
"custom_logo_url": null
},
"name": "My Custom Name",
"position": 2,
"skip_on_failure": false,
"enabled": true,
"created_at": "2025-03-05T15:07:44.285-08:00",
"updated_at": "2025-03-05T15:07:44.285-08:00"
}
}
}