> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Sympa with API Key – StackOne Hub

> Link a Sympa account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using Sympa actions.

> [!WARNING]
>
> You must sign in with administrator privileges to configure an API interface.

## Generate an API key

Sign in to your Sympa HR organization, then open **Settings** and select **API** to manage\
API interfaces.

<ul>
  <li>Format: `https://{your-company}.sympahr.net`</li>
</ul>

**1. Configure the API interface**

Create or select an interface under **API Settings**. Give it an **Interface name**,\
then enable the methods this connection needs under **Interface type**: **Get**,\
**Post** and **Patch**.

<ul>
  <li>Each interface exposes only the fields your administrator adds to it, so make sure the fields you need are configured on this interface.</li>
</ul>

**2. Choose the ApiKey authentication method**

On the interface's authentication settings, choose **ApiKey** as the authentication\
method, then generate the key.

<ul>
  <li>The key is sent on every request as the `X-ApiKey` header.</li>
</ul>

**3. Copy the API key**

Copy the **API Key** across.

## Link the Account

**1. Connect**

<ul>
  <li>Click **Connect**.</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup.</li>
</ul>

**2. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.