For Cyclr to connect with the Vincere API you will need to select a suitable user account within Vincere. This account will require some setup as described below.
Warning: Some users have experienced issues when using the Safari web browser to sign in to Vincere so we would recommend using other web browsers.
- Login to the Vincere Application using the account specific URL, e.g.:
https://{{yourdomain}}.vincere.io/loginForm.do
- Select Settings > Marketplace.
- Select the API Tab.
- Click “Create new token” button, this will display the API Key.
- Click “Create new Client ID” button, this will display the Client ID.
- Set the “Callback URL” field to your Cyclr Partner Console’s Callback URL.
Cyclr Connector Installation
When installing a Vincere Connector, the following values are used:
- Client ID: Vincere Client ID.
- Secret: Leave this blank.
- Domain: This is the subdomain part of the URL used to access the Vincere account, e.g.: if the URL was
https://yourdomain.vincere.io
the value to provide here would be just “yourdomain
“. - API Key: Vincere API Key.
Use Custom Fields
When you use custom fields, the Cyclr Field Location values vary based on the type of the custom field.
For example, to use Candidate custom fields:
- Run the Get Candidate Custom Fields Connector Method to list the available custom fields.
- Make note of the
Key
andType
fields shown in the response.
If you want to add a custom field to Get Candidate, the table below shows the Field Location you need to use depending on the field type.
Custom Field Type | Field Location | Example |
---|---|---|
TEXT_BOX | The custom field’s Key | 12345678901234567890 |
TEXT_AREA | The custom field’s Key | 12345678901234567890 |
CHECK_BOX | The custom field’s Key within square brackets | [09876543210987654321] |
SELECT_BOX | The custom field’s Key within square brackets | [09876543210987654321] |
RADIO | The custom field’s Key within square brackets | [09876543210987654321] |
MULTIPLE_SELECTION | The custom field’s Key within square brackets | [09876543210987654321] |
When you use List methods, such as List New Candidate Records, make sure to include the correct parent array. For example “[items].
“
For more information, see the Cyclr documentation on how to add custom fields to a method.