> ## 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 Deputy with API Key – StackOne Hub

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

> [!WARNING]
>
> The OAuth clients page isn't available on the Deputy Free plan. Use a Deputy account on a paid plan or trial.

## Find your Deputy Endpoint

Your Deputy Endpoint is the address of your Deputy install, without `https://`.

<ul>
  <li>Sign in to your [Deputy account](https://once.deputy.com/my/login) and check the address bar.</li>
  <li>Format: `{install}.{region}.deputy.com`</li>
  <li>Example: if your address is `https://mycompany.au.deputy.com/#roster`, your Deputy Endpoint is `mycompany.au.deputy.com`</li>
</ul>

## Generating a permanent token

A permanent token is generated from an OAuth client in your own Deputy install, and only works for that install.

**1. Create the OAuth client**

In the same browser, open `https://{your-deputy-endpoint}/exec/devapp/oauth_clients`.

<ul>
  <li>Click **New OAuth Client**.</li>
  <li>**Name**: Enter a descriptive name (e.g., `StackOne Integration`)</li>
  <li>**Description**: `Integration with StackOne`</li>
  <li>**Redirect Uri**: any URL, such as `https://example.com`. Permanent tokens don't use it.</li>
  <li>Click **Save This OAuth Client**.</li>
</ul>

![The New OAuth Client form with Name, Description and Redirect Uri filled in and the Save This OAuth Client button highlighted](https://mintcdn.com/stackone-60/NrkRdM_3ihrKqIqB/connectors/deputy/images/api_key-config-new-oauth-client.png?fit=max\&auto=format\&n=NrkRdM_3ihrKqIqB\&q=85\&s=fe43925601be31f09a7c9c3bd68115d1)

**2. Copy the access token**

On the client's page, click **Get An Access Token**.

<ul>
  <li>Copy the token shown after **Access Token is** across to **Permanent Token**.</li>
  <li>The token is only displayed once and cannot be retrieved later. It lasts 10 years.</li>
  <li>Click **OK**.</li>
</ul>

![The access token dialog with the token hidden and the OK button highlighted](https://mintcdn.com/stackone-60/NrkRdM_3ihrKqIqB/connectors/deputy/images/api_key-config-access-token.png?fit=max\&auto=format\&n=NrkRdM_3ihrKqIqB\&q=85\&s=ed28cfc4b3e117e220c5a9eb29327f65)

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

## Next Steps

> [card] [Webhooks setup](https://docs.stackone.com/connectors/deputy/guides/webhook-setup.md)
>
> Configure receiving Events for Deputy into StackOne.


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