Skip to main content

​
What are data connectors?

Data connectors are deeply embedded integration that can connect your live external data with us. A great way to get started is to think of those common questions that your teammates spend considerable time answering, using information currently not available in our platform. These can be questions where your customers simply want to get information that you store on an external system such as, “Is my order delivered?”, or update information such as, “Reschedule a delivery” or “Process a refund” in your external system.

​
Creating a data connector

First, navigate to AI Agent > Data connectors. This is where you can set up data connectors to connect your external data. You can create one by clicking New data connector. You can also search for specific data connectors by their name and status.
Full Data connectors page with search, status filters, existing connectors, and New data connector.

Open AI Agent > Data connectors, then select New data connector.

​
Name and description

Give your data connector a name that clearly indicates its specific function (e.g., “retrieve_order_id”). In the description field, inform your teammates about when to use this connector and what data it will retrieve (e.g., “Fetches order details for a provided Order ID”).
Data connector About step with name and description fields highlighted.

Describe the connector’s purpose in About before configuring its API request. This draft has not been saved.

​
API connection

​
API request

Next, fill in the request details. This is where you’ll need to enter the HTTPS URL to the 3rd party system you’re connecting to. You can specify what data connector you’d like this request to take by selecting the method:
  • GET - Read and store information from the 3rd party system.
  • POST - Create or add information to the 3rd party system.
  • PUT - Update information in the 3rd party system.
  • DELETE - Remove information from the 3rd party system.
  • PATCH - Update information in the 3rd party system.
Data connector API connection step with HTTP method and URL highlighted.

Choose the HTTP method and enter the endpoint URL. This incomplete draft has not sent a request.

​
HTTP headers

You can choose to add any additional parameters to this request by clicking Add header and then add Key value pair under HTTP Headers:
Full API connection form showing Content-Type and Accept request headers.

Select Add header and enter each header as a key-value pair. This example has not been saved or sent.

​
Request body

If you’re making a POST or a PUT request, you’ll have an option to provide a request body to include any data you want to send in the request:
Full data connector page scrolled to the POST JSON request body.

Enter valid JSON in Request Body. This fictional order example has not been sent.

​
Test response

Next, you’ll need to test the response for this data connector to make sure it’s fetching the right data from the external system you’re connecting to.
Important: Testing this request makes a connection with the API so it will complete the data connector you have created. For example, if you’ve asked it to DELETE data from the API, this information will be deleted. Try testing with a GET request to ensure you’re only reading information and not changing it.
Click Test request to check the data connector has been configured correctly.
Test response step with Test Request and a disabled Set live button.

Select Test Request to run the configured API call. No request has been run in this example.

​
Set live

Once you’ve tested your data connector successfully, you’re ready to set it live. Select Set live at the top right after the test succeeds. The untested example above keeps this button disabled.

​
Set to draft

If you want to deprecate old data connectors that are no longer required, you can move them into draft state. You can either click on the data connector you want to move to draft, then select Set to draft or Turn off the status switch in the list.
Full Data connectors list with the Status switches for existing live connectors.

Use the Status switch in the list to move a live connector to draft. The switches shown here have not been changed.

This will check for any dependencies on this data connector. You’ll need to review and resolve these dependencies before moving it to draft state.