Skip to navigation

Create ticket workflow

View as Markdown

Creates a ticket workflow and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
display_namestringRequired>=1 character
A readable name for the workflow.
versionobjectRequired
Document version. On update, send back the num from your last read.
connector_idstringOptional

The connector this workflow’s actions run against. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

conditional_actionslist of objectsOptional
Groups of actions that run when their condition matches.
default_actionobjectOptional
The actions that run when no conditional action matches.

Response

The created ticket workflow
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
display_namestringOptional>=1 character
A readable name for the workflow.
connector_idstringOptional

The connector this workflow’s actions run against. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

conditional_actionslist of objectsOptional
Groups of actions that run when their condition matches.
default_actionobjectOptional
The actions that run when no conditional action matches.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error