Endpoint
GET
/v1/stable/integration

Returns the integrations a project can use and whether each is connected. connectionType says how credentials arrive: api-key ones connect through this API, oauth and app ones only through the Voiceflow UI. The call is unpaginated: it takes no paging parameters, so one request yields the whole set.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Returns one entry per integration the project can use, each with its identifier, display name, connection type, whether credentials are stored, and whether this API can connect it.

integrations
object[]
required
StableIntegration — see its attributes above
Endpoint
POST
/v1/stable/integration/{integration}

Stores the credentials for one api-key integration on the project, in the shape that integration expects; oauth and app integrations connect through the Voiceflow UI instead. The response carries only a confirmation message, so refetch the integration list to see the connection.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

integration
string
required

The integration identifier, as GET /v1/stable/integration lists it (for example twilio).

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

Response

200 - application/json

Confirms the credentials were stored. The body is a message only, so refetch the integration list to see connected flip for this integration.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/integration/{integration}

Clears the stored credentials for one integration on the project, every slot it owns. The response carries only a confirmation message, so refetch the integration list to see it disconnected.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

integration
string
required

The integration identifier, as GET /v1/stable/integration lists it (for example twilio).

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Confirms the integration was disconnected. The body is a message only, so refetch the integration list to see connected turn false.

message
string
required

A human-readable message confirming the deletion.

Endpoint
GET
/v1/stable/integration/{integration}/schema

Returns the tools one integration offers, each with its inputs and the ID it has in this environment once it has been added. Use it to find the toolName that execute and add-tool take.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

integration
string
required

The integration identifier, as GET /v1/stable/integration lists it (for example twilio).

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns every tool the integration offers, attached or not, each with its catalog toolName, inputs, and integrationToolID (null until the tool is added), plus whether the project has credentials stored for the integration.

connected
boolean
required

Whether the project has credentials stored for the integration, as the integration list reports it. A connection saved only in the draft may read false and still run.

tools
object[]
required

Every tool the integration offers, attached or not. Empty for an integration with no tools, such as ElevenLabs.

StableIntegrationSchemaTool — see its attributes above
Endpoint
POST
/v1/stable/integration/{integration}/tool

Adds one of an integration's catalog tools to the environment's draft and returns the integrationToolID that the tool create operation attaches. Adding a tool connects nothing, so the integration still has to be connected before the tool can run.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

integration
string
required

The integration identifier, as GET /v1/stable/integration lists it (for example twilio).

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

toolName
enum<string>
required

The catalog tool to add, as get_schema lists it, such as google_sheets_update_spreadsheet. It must belong to the integration in the path.

Available options: example_dynamic_schema, zendesk_find_user, zendesk_find_group, zendesk_find_ticket, zendesk_create_ticket, zendesk_update_ticket, zendesk_add_ticket_comment, zendesk_update_organization, zendesk_find_latest_comment, salesforce_create_lead, salesforce_update_lead, salesforce_create_contact, salesforce_update_contact, salesforce_create_case, salesforce_update_case, salesforce_add_comment_to_case, shopify_get_products, shopify_get_order, shopify_cancel_order, shopify_update_order, google_sheets_create_spreadsheet, google_sheets_update_spreadsheet, google_sheets_read_spreadsheet, google_sheets_append_spreadsheet, google_sheets_read_row, google_gmail_send_email, airtable_create_records, airtable_delete_records, airtable_get_record, airtable_list_records, airtable_update_records, make_run_scenario, twilio_send_sms, hubspot_create_contact, hubspot_create_lead, hubspot_create_ticket, kustomer_find_customer, kustomer_create_customer, kustomer_update_customer, kustomer_find_conversation, kustomer_find_customer_conversations, kustomer_create_conversation, kustomer_update_conversation, kustomer_add_conversation_note, kustomer_add_conversation_tags, kustomer_find_latest_message, kustomer_find_team, kustomer_update_company

Response

200 - application/json

Returns the integrationToolID to attach the tool with, and created, which is false when the tool had already been added to this environment and nothing changed.

message
string
required

A human-readable message confirming the update.

integrationToolID
string
required

The ID to attach the tool with, through the tool create operation.

created
boolean
required

False when the tool was already added to this environment; nothing changed then.

Use this operation to test agent behavior or execute tools with controlled inputs. For production conversation integrations, use the Agent runtime. Tool execution can affect connected services.
Endpoint
POST
/v1/stable/integration/{integration}/execute

Runs one tool from an integration once, using the project's stored connection and without starting a conversation. The tool acts on the real connected account, so a tool that writes to an external system changes that system.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

integration
string
required

The integration identifier, as GET /v1/stable/integration lists it (for example twilio).

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

toolName
enum<string>
required

The catalog tool to run, as get_schema lists it, such as zendesk_find_ticket. It must belong to the integration in the path.

Available options: example_dynamic_schema, zendesk_find_user, zendesk_find_group, zendesk_find_ticket, zendesk_create_ticket, zendesk_update_ticket, zendesk_add_ticket_comment, zendesk_update_organization, zendesk_find_latest_comment, salesforce_create_lead, salesforce_update_lead, salesforce_create_contact, salesforce_update_contact, salesforce_create_case, salesforce_update_case, salesforce_add_comment_to_case, shopify_get_products, shopify_get_order, shopify_cancel_order, shopify_update_order, google_sheets_create_spreadsheet, google_sheets_update_spreadsheet, google_sheets_read_spreadsheet, google_sheets_append_spreadsheet, google_sheets_read_row, google_gmail_send_email, airtable_create_records, airtable_delete_records, airtable_get_record, airtable_list_records, airtable_update_records, make_run_scenario, twilio_send_sms, hubspot_create_contact, hubspot_create_lead, hubspot_create_ticket, kustomer_find_customer, kustomer_create_customer, kustomer_update_customer, kustomer_find_conversation, kustomer_find_customer_conversations, kustomer_create_conversation, kustomer_update_conversation, kustomer_add_conversation_note, kustomer_add_conversation_tags, kustomer_find_latest_message, kustomer_find_team, kustomer_update_company
inputs
object

The tool's inputs, keyed by input name and typed as get_schema says. A top-level string value follows the ExecuteInputString rules, so {secret_name} inserts a project secret. Secrets work only at the top level: inside a nested object or array, {secret_name} is sent as written and no secret is filled in.

extendedInputVariables
object

Provider metadata the tool editor stored for this tool, such as Zendesk custom field IDs. Omit it unless you are replaying an editor run.

Response

200 - application/json

Returns what the tool returned in output, or null when the run failed. Secret values read [secret] in the result.

success
boolean
required

Whether the tool ran and reported no error.

latencyMs
number
required

How long the run took, in milliseconds, measured by this API around the call.

error
string
required

Why the run failed when success is false, otherwise null. Secret values read [secret].

truncated
boolean
required

Whether a returned payload was over 64 KB and was cut to its first 64 KB of JSON text, which then arrives as a string.

output
any
required

What the integration tool returned, or null when the run failed. Secret values read [secret].

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.