Skip to content

Connect or update a workflow integration

POST
/workflows/integrations/{provider_name}

UPSERT: creates the integration or replaces its configuration.

POST rather than PUT because that is the verb voice exposes, and one spelling is better than two.

Whatever is stored here is used BY WORKFLOW NODES ACTING AS THE PLATFORM, so a key placed here is a standing grant, not a one-off.

Authorizations

Parameters

Path Parameters

provider_name
required

Provider name.

string
>= 1 characters

Provider name.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

object
api_key
Any of:
string
configuration
Any of:
object
key
additional properties
any

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string