# Data connectors

## 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 Integrations > Data connectors

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2FkP18RnDfco3Zud2vdETa%2Fimage.png?alt=media&#x26;token=aade8b7f-be7a-4bce-9263-a4548df18633" alt=""><figcaption></figcaption></figure>

This is where you can set up data connectors to connect your external data. You can create one by clicking the \[+ New data connector] button. You can also search for specific data connectors by their name and status.

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2Fz5bReTErug376SNPKFjX%2Fimage.png?alt=media&#x26;token=265fe876-d1bf-4876-a7f8-0a657fa657b1" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2FKatsIk5d55WCbdsxYaZk%2Fimage.png?alt=media&#x26;token=0f175598-1e5a-47b3-961e-ecd4707f2a8a" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2FhIibUV6yxwUVw09fgSKQ%2Fimage.png?alt=media&#x26;token=a94a9e86-97cc-4b4d-876f-fc954540ead4" alt=""><figcaption></figcaption></figure>

### **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:

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2Fe3GP8SdEr2pJ1mXWawcm%2Fimage.png?alt=media&#x26;token=94aebad1-af3e-4478-a0f2-1576aeb8f5a0" alt=""><figcaption></figcaption></figure>

### **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:

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2F5bBWPEdD8Mur4S5Vt2Ke%2Fimage.png?alt=media&#x26;token=ccb0f7ac-e173-4188-9d3a-b712d6f6fa87" alt=""><figcaption></figcaption></figure>

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

{% hint style="warning" %}
**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.
{% endhint %}

Click **Test request** to check the data connector has been configured correctly.

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2Fj4jTka3IP2KK1U8tYO27%2Fimage.png?alt=media&#x26;token=041e1fc5-ef07-437e-b0d1-c37c95831b33" alt=""><figcaption></figcaption></figure>

### Set live

Once you’ve tested your data connector successfully, you’re ready to set it live.

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2FDzPmyvHJWNh1DhL8KdjH%2Fimage.png?alt=media&#x26;token=0af58698-f635-4678-9575-c7cda8b53e25" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3466127247-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSIAnjLP6KQY5rvyuaq5K%2Fuploads%2FoTIvEUDoADjcCwAItOpL%2Fimage.png?alt=media&#x26;token=e6ea2855-a7a5-4e05-8c01-32bcc89b9fe3" alt=""><figcaption></figcaption></figure>

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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://helpdocs.ycloud.com/help-center/integrations/data-connectors.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.