Execute integration tool
POST
Execute integration tool

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

integration
string
required

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).

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
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.

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].

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