Create workflow

POST /v1/Workspaces/{WorkspaceSid}/Workflows

TODO: Resource-level docs

Path parameters

WorkspaceSid string Required

The SID of the Workspace that the new Workflow to create belongs to.

Body

AssignmentCallbackUrl string(uri)

The URL from your application that will process task assignment events. See Handling Task Assignment Callback for more details.
Configuration string Required

A JSON string that contains the rules to apply to the Workflow. See Configuring Workflows for more information.
FallbackAssignmentCallbackUrl string(uri)

The URL that we should call when a call to the assignment_callback_url fails.
FriendlyName string Required

A descriptive string that you create to describe the Workflow resource. For example, Inbound Call Workflow or 2014 Outbound Campaign.
TaskReservationTimeout integer

How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to 86,400 (24 hours) and the default is 120.

Responses

201

Created
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- assignment_callback_url string(uri) | null
  
  The URL that we call when a task managed by the Workflow is assigned to a Worker
- configuration string | null
  
  A JSON string that contains the Workflow's configuration
- date_created string(date-time) | null
  
  The RFC 2822 date and time in GMT when the resource was created
- date_updated string(date-time) | null
  
  The RFC 2822 date and time in GMT when the resource was last updated
- document_content_type string | null
  
  The MIME type of the document
- fallback_assignment_callback_url string(uri) | null
  
  The URL that we call when a call to the assignment_callback_url fails
- friendly_name string | null
  
  The string that you assigned to describe the Workflow resource
- links object(uri-map) | null
  
  The URLs of related resources
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WW[0-9a-fA-F]{32}$.
- task_reservation_timeout integer | null
  
  How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker
- url string(uri) | null
  
  The absolute URL of the Workflow resource
- workspace_sid string | null
  
  The SID of the Workspace that contains the Workflow
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

POST /v1/Workspaces/{WorkspaceSid}/Workflows

curl \
 -X POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Workflows \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'AssignmentCallbackUrl=https%3A%2F%2Fexample.com&Configuration=string&FallbackAssignmentCallbackUrl=https%3A%2F%2Fexample.com&FriendlyName=string&TaskReservationTimeout=42'

Request example

{
  "AssignmentCallbackUrl": "https://example.com",
  "Configuration": "string",
  "FallbackAssignmentCallbackUrl": "https://example.com",
  "FriendlyName": "string",
  "TaskReservationTimeout": 42
}

Request examples

{
  "AssignmentCallbackUrl": "https://example.com",
  "Configuration": "string",
  "FallbackAssignmentCallbackUrl": "https://example.com",
  "FriendlyName": "string",
  "TaskReservationTimeout": 42
}

Response examples (201)

{
  "account_sid": "string",
  "assignment_callback_url": "https://example.com",
  "configuration": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "document_content_type": "string",
  "fallback_assignment_callback_url": "https://example.com",
  "friendly_name": "string",
  "links": {},
  "sid": "string",
  "task_reservation_timeout": 42,
  "url": "https://example.com",
  "workspace_sid": "string"
}

Response examples (201)

{
  "account_sid": "string",
  "assignment_callback_url": "https://example.com",
  "configuration": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "document_content_type": "string",
  "fallback_assignment_callback_url": "https://example.com",
  "friendly_name": "string",
  "links": {},
  "sid": "string",
  "task_reservation_timeout": 42,
  "url": "https://example.com",
  "workspace_sid": "string"
}