SAP Cloud Platform Open Connectors

SmartRecruiters Events

SAP Cloud Platform Open Connectors supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

SAP Cloud Platform Open Connectors supports polling events for SmartRecruiters. After receiving an event, SAP Cloud Platform Open Connectors standardizes the payload and sends an event to the configured callback URL of your authenticated connector instance.

You can set up polling for the events resource. You can also copy the events configuration to poll other resources. See Configure Polling Through API for more information.

Note: Unless configured for a specific time zone, polling occurs in UTC.

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate a connector instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Connector Instance with Events (UI) or the connector-specific authentication topic.

Configure Polling Through API

Use the /instances endpoint to authenticate with SmartRecruiters and create a connector instance with polling enabled.

Note: The endpoint returns a connector instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this connector instance.

To authenticate a connector instance with polling:

  1. Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.
  2. Construct a JSON body as shown below (see Parameters):

    {
      "element":{
        "key":"smartrecruiters"
      },
      "configuration":{
        "api.key": "<SmartRecruiters SmartRecruiters API Key>",
        "event.notification.enabled": true,
        "event.vendor.type": "polling",
        "event.notification.callback.url": "<Your Callback URL>",
        "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>",
        "event.poller.refresh_interval": "<minutes>",
        "event.poller.configuration":{
          "candidates":{
            "url":"/hubs/humancapital/candidates?where=updatedAfter='${gmtDate:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
            "idField":"id",
            "datesConfiguration":{
              "updatedDateField":"updatedOn",
              "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
              "updatedDateTimezone":"GMT",
              "createdDateField":"createdOn",
              "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
              "createdDateTimezone":"GMT"
            }
          }
        }
      },
      "tags":[
        "<Add_Your_Tag>"
      ],
      "name":"<INSTANCE_NAME>"
    }
    
  3. 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.
  4. Locate the token and id in the response and save them for all future requests using the connector instance.

Example cURL with Polling

curl -X POST \
https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/instances \
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
"element": {
  "key": "smartrecruiters"
},
"configuration": {
    "api.key": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
      "event.notification.callback.url": "https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/events//",
    "event.notification.signature.key": "asdfo08e$fd",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration":{
      "candidates":{
        "url":"/hubs/humancapital/candidates?where=updatedAfter='${gmtDate:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField":"id",
        "datesConfiguration":{
          "updatedDateField":"updatedOn",
          "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "updatedDateTimezone":"GMT",
          "createdDateField":"createdOn",
          "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateTimezone":"GMT"
          }
        }
    }
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance with Polling"
}'

Parameters

API parameters not shown in SAP Cloud Platform Open Connectors are in code formatting.

ParameterDescriptionData Type
keyThe connector key.
smartrecruiters
string
Name
name
The name of the connector instance created during authentication.Body
API Key
api.key
The SmartRecruiters SmartRecruiters API Key that you noted in API Provider Setupstring
Events Enabled
event.notification.enabled
Optional. Identifies that events are enabled for the connector instance.
Default: false.
boolean
Event Notification Callback URL
event.notification.callback.url
The URL where you want SAP Cloud Platform Open Connectors to send the events.string
Callback Notification Signature Key
event.notification.signature.key
Optional. A user-defined key for added security to show that events have not been tampered with.string
Event poller refresh interval (mins)
event.poller.refresh_interval
A number in minutes to identify how often the poller should check for changes.number
Configure Polling
event.poller.configuration
Optional. Configuration parameters for polling.JSON object
Resource to PollThe polling event configuration of the resource that you will monitor.JSON object
URL
url
The url to query for updates to the resource.String
ID Field
idField
The field in the resource that is used to uniquely identify it.String
Advanced Filtering
datesConfiguration
Configuration parameters for dates in pollingJSON Object
Updated Date Field
updatedDateField
The field that identifies an updated object.String
Updated Date Format
updatedDateFormat
The date format of the field that identifies an updated object.String
Created Date Field
createdDateField
The field that identifies a created object.String
Created Date Format
createdDateFormat
The date format of the field that identifies a created object.String
tagsOptional. User-defined tags to further identify the instance.string