> For the complete documentation index, see [llms.txt](https://docs.edgetag.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgetag.io/channels/cordial/onboarding.md).

# Onboarding

### Obtaining the API Endpoint URL

When logging in to Cordial, you should be able to see which domain your account belongs to. This will determine which endpoint you need to select from the dropdown in the form.

<figure><img src="https://1474399258-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZJWZKbUk0hRISkCIj2p4%2Fuploads%2FbnjIcvebMUHFvDId3PIB%2Fimage.png?alt=media&amp;token=2165680f-fc92-4718-abdc-716a3975cf49" alt=""><figcaption></figcaption></figure>

### Creating an API Key

To create an API key to use for this channel, please follow the instructions described in the Create an API Key section of Cordial's knowledge base article:

{% embed url="<https://support.cordial.com/hc/en-us/articles/115005365087-API-keys>" %}

The configuration you'll need to use for the API key is as follows:

<figure><img src="https://1474399258-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZJWZKbUk0hRISkCIj2p4%2Fuploads%2FsWQhFtIxiMxVzDBJJEVM%2Fimage.png?alt=media&amp;token=f6113aa1-30b6-4256-9eb2-97a12e805526" alt=""><figcaption></figcaption></figure>

You should now be able to copy the API key to the clipboard for the next step.

### Adding the Cordial Channel

Open your site's view and add the Cordial channel, which will open up the provider form.

<figure><img src="https://1474399258-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZJWZKbUk0hRISkCIj2p4%2Fuploads%2FXv2WMmat6t6E6rDl4aft%2Fimage.png?alt=media&amp;token=d6a3a152-9f1e-43af-bbd3-a17e647db09a" alt=""><figcaption></figcaption></figure>

Enter a channel name and select the matching API URL that you've identified in the first step above. For the **Access Token,** use the API key value that you copied in the second step. After clicking **Save & Deploy,** your channel is set up and should start sending events to Cordial.


---

# 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.edgetag.io/channels/cordial/onboarding.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.
