External Service Integrations

External Service Integrations

• External Service Integrations are used to either retrieve input data to set variable values or to update data in external systams i.e. output variable values.

• This differs from RAG and Content Retrieval Integrations which inject text directly into the LLM prompt at each turn.

• External Service integrations are triggered by transitions between Stages. They can be configured to trigger when a specific Transition is taken, when a Stage is entered or when a Stage is exited.

Canned External Service Integrations

Integrations in this category support calling webhooks on several popular automation platforms.

• We currently support calling webhooks using the POST method for the following automation platforms: Slack, Make, Zapier and n8n.

• These can be used to update external data sources or to trigger external behaviour.

Custom Function Integrations

The Custom Function Integration type enables authors to call almost any external service to retrieve or send variable values.

• Calls to services can be made via REST API's or GraphQL API's

Defining Integrations

• In much the same way that Variables need to be defined before they can be used, you will need to define a specific integration before it can be used in your Agent.

• This is to support configuring a single integration with keys and other boilerplate parameters and then specifying the use of them throughout your Agent, customizing them according to the location of use.

• To define an integration:

  1. Navigate to the Integrations section of the Agent and click on the ’+’ icon at top right.

  2. Select an Integration type and fill in the details.

Using a Defined Integration

• Once defined, an integration will be available for selection in the Agent's list of integrations.

• You can use the Integration definition and configure it for each Stage and Transition where it is required as well as in the Common Stage Settings of your Agent.