> For the complete documentation index, see [llms.txt](https://docs.ixhello.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ixhello.com/ixhc/apps/custom-skills-series-step-2-creating-a-connection.md).

# Custom App Series - Step 2 - Creating a Connection

## Objective

This document will demonstrate how to set up a custom connection to an external Web API endpoint.

## Introduction to API

The iX Hello platform can integrate with external platform via Web API’s and to demonstrate this capability, we have created a demo API endpoint (<https://jsonplaceholder.typicode.com/users>) in our web app “[https://bots.ixhello.com](https://bots.ixhello.com/)”. We created multiple API endpoints for Contacts module and will be using the endpoint that searches an underlying contacts database and returns the contact number of a specific person.

The web app that we created has the ability to perform CRUD operations against the underlying contacts database that is triggered by calls to the exposed contact API’s in [https://bots.ixhello.com](https://bots.ixhello.com/)

Web App URL: [https://bots.ixhello.com](https://bots.ixhello.com/)

Contact Finder: <https://jsonplaceholder.typicode.com/users>

Here is a sample contact in the database.

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2FuS4NkGgQ2lOub6GcsEH2%2Fimage.png?alt=media&amp;token=7145449b-2a07-4681-bebf-0c8bf2f68ad0" alt=""><figcaption></figcaption></figure>

## Goal

Our goal will be on how to setup a custom connection to an external web API endpoint and check if the connection is validated.

## Steps

To be able to set up a custom connection in the iX Hello platform, it is mandatory to first sign up on the iX Hello platform. To sign up, please go to this link [here](https://bots.ixhello.com/). Set up connection to the external web API

## Set up connection to the external web API

1. Login to the iX Hello platform, use left navigation menu and click “**Integration**” then select “**Connect System”**. In the resulting page, click “**Connect External Systems**”.

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2F8bJGVAMGAhw2yf0ew9oZ%2Fimage.png?alt=media&amp;token=86482e60-e3db-4e87-a36d-b4f2e9fa8c07" alt=""><figcaption></figcaption></figure>

2. In “**Connect External System**” select or do the following:

**Choose Connection:** Rest API Service

**Click**: Next

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2FXVvF9hn9Uy1H2Mxsly7s%2Fimage.png?alt=media&amp;token=fa100b44-d8b8-4dd1-b4ed-42d98a464c1c" alt=""><figcaption></figcaption></figure>

3. Once in “**Rest API Service Setup**” select or enter the following:

**System Instance Name:** ContactFinder

**Authorization Type:** No Auth

**Base API URL:** jsonplaceholder.typicode.com/

**Click Save**

Click on Validate System and Click on Save after the connection is validated.

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2FROWnhkEICZiwLT7itAWf%2Fimage.png?alt=media&amp;token=9419e779-cd37-499f-90a9-6556254f7c15" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2F2JFahSPX9OYkUCb2n7ZQ%2Fimage.png?alt=media&amp;token=0ec11d71-3e26-46fc-97a8-1692956c4ed4" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ixhello.com/ixhc/apps/custom-skills-series-step-2-creating-a-connection.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
