SmartRecruiters Authenticate an Element

You can authenticate with SmartRecruiters to create your own instance of the SmartRecruiters element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the SmartRecruiters platform.

Authenticate Through the UI

Use the UI to authenticate with SmartRecruiters and create an element instance as described in Authenticate an Element Instance (UI). In addition to the base authentication parameters, you will need the credentials that you identified in API Provider Setup.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

To authenticate an element instance:

  1. Construct a JSON body as shown below (see Parameters):

      "element": {
        "key": "smartrecruiters"
      "configuration": {
        "api.key": "<SmartRecruiters SmartRecruiters API Key>"
      "tags": [
      "name": "<INSTANCE_NAME>"
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \ \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "smartrecruiters"
  "configuration": {
    "api.key": "xxxxxxxxxxxxxxxxxxxxxxxxx"
  "tags": [
  "name": "API Instance"


API parameters not shown in Cloud Elements are in code formatting.

Note: Event related parameters are described in Events.
ParameterDescriptionData Type
keyThe element key.
The name of the element instance created during authentication.string
The SmartRecruiters API Key that you noted in API Provider Setup.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

  "id": 12345,
  "name": "API Instance",
  "createdDate": "2018-04-04T20:44:36Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",
  "element": {
    "id": 6159,
    "name": "SmartRecruiters ",
    "hookName": "SmartRecruiters",
    "key": "smartrecruiters",
    "description": "Add a SmartRecruiters Instance to connect your existing SmartRecruiters account to the Human Capital Hub, allowing you to manage all of your Human Capital activities across multiple ERP elements. You will need your SmartRecruiters  account information to add an instance.",
    "image": "elements/custom-element-default-logo.png",
    "active": false,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": [ ],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": true,
    "extendable": true,
    "beta": false,
    "authentication": {
        "type": "custom"
    "extended": false,
    "hub": "humancapital",
    "protocolType": "http",
    "parameters": [  ],
    "private": false
  "elementId": 6159,
  "tags": [
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {    },
  "eventsEnabled": false,
  "traceLoggingEnabled": false,
  "cachingEnabled": false,
  "externalAuthentication": "none",
    "user": {
        "id": 123456,
        "emailAddress": "",
        "firstName": "Claude",
        "lastName": "Elements"