Integration keys authenticate the calls other systems make to the Coodesh API, such as your ATS integration or the Datalake data export. Each key belongs to a workspace.
To manage keys, open the workspace menu (your company logo, top left corner) and click Integrations. The page is also available under Settings › Integrations.
Who can manage keys
Creating, editing and deleting keys requires the Manage integration keys permission. Admins and Managers have it by default, and it can also be granted individually to other people in the workspace.
Create a key
In the Integration Keys section, click New Key and fill in the fields:
Name (required): a name that shows where the key is used, for example "ATS integration".
Description: optional details about the integration.
Provider (required): the platform that will use the key, such as Gupy, Greenhouse, Lever or InHire. If yours is not listed, keep the default option, Coodesh.
Permissions (required): the actions the key can perform: List, Get, Create, Update and Delete. All of them come selected; clear the ones your integration does not use.
Click Save and continue. The key is shown on the next screen, with a button to copy it.
The key is shown only once. Copy it now and store it somewhere safe, or paste it straight into the integration platform. After that, the table only shows a masked version of the key.
Accessible resources
The Accessible resources field defines which groups of endpoints the key can reach, such as the standard endpoints and the Datalake ones. It is set up by the Coodesh team.
With no resources set, the key can call the standard API endpoints but not the Datalake ones. If your integration needs the Datalake, ask your account contact or support to enable it, giving them the key name. See Datalake: exporting data to BI and your data warehouse.
Edit a key
In the table, click Edit on the key row. You can change:
Name
Description
Provider
Permissions
For security reasons, the key value and its ID cannot be changed. To replace a key, create a new one and delete the old one.
Delete a key
In the table, click Delete on the key row and confirm. Deleting cannot be undone, and any integration using that key stops working.
Lost your key?
The key cannot be viewed again. To get access back:
Create a new key following the steps above.
Update your integration with the new key.
Delete the old key.