On this page

SAP 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 Open Connectors supports webhook events for HireRight. After receiving an event, SAP Open Connectors standardizes the payload and sends an event to the configured callback URL of your authenticated connector instance.

Configure Webhooks Through the UI

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

Configure Webhooks Through API

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

   {
     "element": {
       "key": "hireright"
     },
      "configuration": {
       "event.vendor.type": "webhook",
       "hireright.wsdl.location": "https://connect.hireright.com/wsdl/HireRightAPI.wsdl", <"OPTIONAL_WSDL_LOCATION">
       "hireright.endpoint.url": "https://api.hireright.com:11443/ws_gateway/HireRightAPI/v/1/2", <"INSERT_HIRERIGHT_ENDPOINT_URL">
       "event.notification.enabled": true,
       "filter.response.nulls": "true",
       "hireright.username": "HireRightUserName", <"INSERT_HIRERIGHT_USERNAME">
       "hireright.password": "HireRIghtPassword", <"INSERT_HIRERIGHT_PASSWORD">
       "hireright.account.id": "HireRightAccountID", <"INSERT_HIRERIGHT_ACCOUNTID">
       "hireright.company.login": "HireRightCompanyLogin", <"INSERT_HIRERIGHT_COMPANYLOGIN">
       "hireright.user.ref.id": "HireRightUserRefID", <"INSERT_HIRERIGHT_USERREDIF">
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "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 connector instance.

Example cURL

curl -X POST 'https://staging.cloud-elements.com/elements/api-v2/elements/741/instances' \
 -H 'Authorization: User ******, Organization ******'  \
 -H 'Content-Type: application/json'  \
-d 
'{
  "name": "MyCoolInstance",
  "configuration": {
    "event.vendor.type": "webhook",
    "hireright.wsdl.location": "https://connect.hireright.com/wsdl/HireRightAPI.wsdl",
    "hireright.endpoint.url": "https://api.hireright.com:11443/ws_gateway/HireRightAPI/v/1/2",
    "event.notification.enabled": true,
    "filter.response.nulls": "true",
    "hireright.username": "HireRightUserName",
    "hireright.password": "HireRightPassword",
    "hireright.account.id": "HireRightAccountID",
    "hireright.company.login": "HireRightCompanyLogin",
    "hireright.user.ref.id": "HireRightUserRefID",
    "event.notification.signature.key": "signatureKey",
    "default.select.fields.map": "selectField1,selectFIeld2,selectField3"
  }
}'

Parameters

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