Skip to main content
Your API key is shown only once, when it is created. Copy it before you close the dialog.

Create an API key in BreezyHR

BreezyHR calls these keys personal access tokens. A key belongs to the user who creates it and carries that user’s permissions, so sign in to BreezyHR as a Company Administrator before you start.

1

Open your personal settings

Click your user icon in the lower-left corner of BreezyHR, then select My Settings.

BreezyHR account menu open from the user icon with My Settings highlighted
2

Open the API Keys tab

On the My Settings page, select the API Keys tab.

My Settings page with the API Keys tab highlighted alongside Profile, Shortcuts, Appearance, and Signature
3

Create a new key

Click Create API Key to open the key dialog.

API Keys tab with the Create API Key button highlighted
4

Name the key and set its expiration

Fill in the dialog, then click Create Key.

  • Enter a Name that identifies this integration, for example StackOne Integration.
  • Choose an Expiration. Leave it on No expiration so the connection keeps working.
Create API Key dialog with the Name field, Expiration dropdown, and Create Key button highlighted
5

Copy the key into StackOne

BreezyHR shows the new key once, in the Your New API Key dialog. Click Copy, then paste the value into the API Key field in StackOne Hub. The key begins with breezy_pat_.

Your New API Key dialog with the Copy button highlighted and the token value masked

Add your Company ID

The Company ID is optional and is used for webhook registration and company-scoped calls. Leave it empty unless you plan to use BreezyHR webhook events.

1

Copy the Company ID into StackOne

Once the account is connected, run the list_companies action and copy the _id value of the company you want into the Company ID field in StackOne Hub.

1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.