Skip to content

Try a Roam or Slack token

POST
/workflows/integrations/{provider_name}/test

REACHES OUTSIDE GRAPH8. Calls the provider with the token and reports whether it works (success, error). The token is not stored; save it with PUT /workflows/integrations/{provider_name}.

Authorizations

Parameters

Path Parameters

provider_name
required

Roam or slack.

string
Allowed values: roam slack

Roam or slack.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Voice WorkflowIntegrationTestRequest.

object
api_key
required

The token to try. Not stored.

string
>= 1 characters

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