Datadog Workflows API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.
This API exposes
13 operations
across 7 paths,
and defines 97 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.
The identity and technical contract details declared by the specification.
Annotation
object
A list of annotations used in the workflow. These are like sticky notes for your workflow!
3 properties
3 required
SoftwareCatalogTriggerWrapper
object
Schema for a Software Catalog-based trigger.
2 properties
1 required
MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest
object
Update Workflows webhook handle request.
1 property
1 required
WorkflowDataUpdate
object
Data related to the workflow being updated.
4 properties
2 required
APITrigger
object
Trigger a workflow from an API request. The workflow must be published.
1 property
StartStepNames
array
A list of steps that run first after a trigger fires.
UpdateWorkflowRequest
object
A request object for updating an existing workflow.
1 property
1 required
JSONAPIErrorItem
object
API error response body
5 properties
OutputSchemaParametersType
string
The definition of OutputSchemaParametersType object.
GithubWebhookTrigger
object
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL…
1 property
WorklflowGetInstanceResponse
object
The state of the given workflow instance.
1 property
CreateWorkflowResponse
object
The response object after creating a new workflow.
1 property
1 required
MicrosoftTeamsWorkflowsWebhookHandlesResponse
object
Response with a list of Workflows webhook handles.
1 property
1 required
StepDisplayBounds
object
The definition of StepDisplayBounds object.
2 properties
MicrosoftTeamsWorkflowsWebhookHandleAttributes
object
Workflows Webhook handle attributes.
2 properties
JSONAPIErrorResponse
object
API error response.
1 property
1 required
InputSchema
object
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
1 property
CaseTrigger
object
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
1 property
AppTriggerWrapper
object
Schema for an App-based trigger.
2 properties
1 required
WorklflowCancelInstanceResponse
object
Information about the canceled instance.
1 property
WorkflowTriggerWrapper
object
Schema for a Workflow-based trigger.
2 properties
1 required
GithubWebhookTriggerWrapper
object
Schema for a GitHub webhook-based trigger.
2 properties
1 required
Trigger
One of the triggers that can start the execution of a workflow.
UpdateWorkflowResponse
object
The response object after updating a workflow.
1 property
StepDisplay
object
The definition of StepDisplay object.
1 property
MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes
object
Workflows Webhook handle attributes.
2 properties
2 required
WorkflowDataUpdateAttributes
object
The definition of WorkflowDataUpdateAttributes object.
8 properties
TriggerRateLimit
object
Defines a rate limit for a trigger.
2 properties
ConnectionEnvEnv
string
The definition of ConnectionEnvEnv object.
MicrosoftTeamsWorkflowsWebhookHandleResponseData
object
Workflows Webhook handle data from a response.
3 properties
WorkflowInstanceListItem
object
An item in the workflow instances list.
1 property
DatabaseMonitoringTriggerWrapper
object
Schema for a Database Monitoring-based trigger.
2 properties
1 required
WorkflowListInstancesResponse
object
Response returned when listing workflow instances.
2 properties
AnnotationDisplay
object
The definition of AnnotationDisplay object.
1 property
ScheduleTriggerWrapper
object
Schema for a Schedule-based trigger.
2 properties
1 required
WorkflowInstanceCreateMeta
object
Additional information for creating a workflow instance.
1 property
JSONAPIErrorItemSource
object
References to the source of the error.
3 properties
WorkflowListInstancesResponseMetaPage
object
Page information for the list instances response.
1 property
SecurityTriggerWrapper
object
Schema for a Security-based trigger.
2 properties
1 required
WorkflowDataAttributes
object
The definition of WorkflowDataAttributes object.
8 properties
2 required
IncidentTrigger
object
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
1 property
ConnectionGroup
object
The definition of ConnectionGroup object.
3 properties
3 required
ReadinessGateThresholdType
string
The definition of ReadinessGateThresholdType object.
AnnotationMarkdownTextAnnotation
object
The definition of AnnotationMarkdownTextAnnotation object.
1 property
WorklflowGetInstanceResponseData
object
The data of the instance response.
1 property
SelfServiceTriggerWrapper
object
Schema for a Self Service-based trigger.
2 properties
1 required
OutputSchemaParameters
object
The definition of OutputSchemaParameters object.
6 properties
2 required
SecurityTrigger
object
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
1 property
CaseTriggerWrapper
object
Schema for a Case-based trigger.
2 properties
1 required
WorklflowGetInstanceResponseDataAttributes
object
The attributes of the instance response data.
1 property
MonitorTrigger
object
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
1 property
WorkflowDataRelationships
object
The definition of WorkflowDataRelationships object.
2 properties
MicrosoftTeamsCreateWorkflowsWebhookHandleRequest
object
Create Workflows webhook handle request.
1 property
1 required
APIErrorResponse
object
API error response.
1 property
1 required
WorkflowListInstancesResponseMeta
object
Metadata about the instances list
1 property
RetryStrategyLinear
object
The definition of RetryStrategyLinear object.
2 properties
2 required
WorkflowUserRelationshipType
string
The definition of WorkflowUserRelationshipType object.
CompletionCondition
object
The definition of CompletionCondition object.
3 properties
2 required
CompletionConditionOperator
string
The definition of CompletionConditionOperator object.
OutputSchema
object
A list of output parameters for the workflow.
1 property
InputSchemaParameters
object
The definition of InputSchemaParameters object.
5 properties
2 required
ConnectionEnv
object
A list of connections or connection groups used in the workflow.
3 properties
1 required
WorkflowInstanceCreateRequest
object
Request used to create a workflow instance.
1 property
WorkflowInstanceCreateResponseData
object
Data about the created workflow instance.
1 property
MicrosoftTeamsWorkflowsWebhookHandleType
string
Specifies the Workflows webhook handle resource type.
InputSchemaParametersType
string
The definition of InputSchemaParametersType object.
Parameter
object
The definition of Parameter object.
2 properties
2 required
WorkflowDataType
string
The definition of WorkflowDataType object.
DashboardTriggerWrapper
object
Schema for a Dashboard-based trigger.
2 properties
1 required
WorkflowInstanceCreateResponse
object
Response returned upon successful workflow instance creation.
1 property
Connection
object
The definition of Connection object.
2 properties
2 required
ReadinessGate
object
Used to merge multiple branches into a single branch.
1 property
1 required
ChangeEventTriggerWrapper
object
Schema for a Change Event-based trigger.
2 properties
1 required
OutboundEdge
object
The definition of OutboundEdge object.
2 properties
2 required
APITriggerWrapper
object
Schema for an API-based trigger.
2 properties
1 required
AnnotationDisplayBounds
object
The definition of AnnotationDisplayBounds object.
4 properties
NotebookTriggerWrapper
object
Schema for a Notebook-based trigger.
2 properties
1 required
WorkflowData
object
Data related to the workflow.
4 properties
2 required
MicrosoftTeamsWorkflowsWebhookHandleResponse
object
Response of a Workflows webhook handle.
1 property
1 required
CreateWorkflowRequest
object
A request object for creating a new workflow.
1 property
1 required
WorkflowUserRelationship
object
The definition of WorkflowUserRelationship object.
1 property
WorkflowUserRelationshipData
object
The definition of WorkflowUserRelationshipData object.
2 properties
2 required
MicrosoftTeamsWorkflowsWebhookHandleRequestData
object
Workflows Webhook handle data from a response.
2 properties
2 required
IncidentTriggerWrapper
object
Schema for an Incident-based trigger.
2 properties
1 required
SlackTriggerWrapper
object
Schema for a Slack-based trigger.
2 properties
1 required
RetryStrategy
object
The definition of RetryStrategy object.
2 properties
1 required
MicrosoftTeamsWorkflowsWebhookResponseAttributes
object
Workflows Webhook handle attributes.
1 property
RetryStrategyKind
string
The definition of RetryStrategyKind object.
ErrorHandler
object
Used to handle errors in an action.
2 properties
2 required
MonitorTriggerWrapper
object
Schema for a Monitor-based trigger.
2 properties
1 required
MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData
object
Workflows Webhook handle data from a response.
2 properties
2 required
CompletionGate
object
Used to create conditions before running subsequent actions.
2 properties
2 required
WorklflowCancelInstanceResponseData
object
Data about the canceled instance.
1 property
Spec
object
The spec defines what the workflow does.
7 properties
Step
object
A Step is a sub-component of a workflow. Each Step performs an action.
9 properties
2 required
ScheduleTrigger
object
Trigger a workflow from a Schedule. The workflow must be published.
1 property
1 required
GetWorkflowResponse
object
The response object after getting a workflow.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
