Getting your Subdomain
Your subdomain is used to identify your Eploy instance.
Find the Subdomain
You can find the subdomain in the URL of your Eploy account by taking the portion that appears before .eploy.net and after https://.
- Example URL:
https://stackone.eploy.net/ - Subdomain value:
stackone
Generating Client ID and Client Secret
You need to create an API key in Eploy to generate the Client ID and Client Secret.
Navigate to API Keys
In the top navigation bar go to Admin → System / Security Settings → API Keys.
Create a New API Key
On the top-right select New → Rest API.
Name the API Key
Enter a title for the API Key, for example: StackOne.
- Select an API User for your API Key to use
- Click Save
Record Client ID and Client Secret
Your Client ID and Client Secret will be generated and displayed to you.
- Copy both values and store them securely for use later
- These credentials are only shown once
Assign API Permissions
Assign API permissions based on the integration requirements by clicking on the Add button.
- Select and enable each required API permission (Actions, Applications, Candidates, Companies, Contacts, Files, Placements, Timesheets, Users, Vacancies, etc.)
- Click Save for each permission added
Configuring Scopes (Optional)
You can optionally restrict API access by specifying scopes.
Understanding Scopes
Scopes control which API operations are allowed. If not specified, all scopes assigned to the API key will be available.
- Format: comma-separated list (e.g.,
candidates.read,candidates.insert,applications.read) - Only scopes assigned during API key configuration will be allowed
- Leave blank to use all available scopes
Link the Account
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.
Use Actions