Cloud Elements 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
Cloud Elements supports webhook events for HireRight. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance.
Configure Webhooks Through the UI
To configure webhooks through the UI, follow the same steps to authenticate an element instance, and then turn on events. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.
Configure Webhooks Through API
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>" }
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.Locate the
token
andid
in the response and save them for all future requests using the element 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 Cloud Elements are in code formatting
.
Parameter | Description | Data Type |
---|---|---|
Namename | The name for the element instance created during authentication. | Body |
WSDL Pathhireright.wsdl.location | Optional. The WSDL path appears in the URL that HireRight redirects you to after you log in. For example, in https://my.hireright.com/v2017_2/hireright.aspx?locale=en_US&session=... , the WSDL path is /v2017_2/apis/2.0/ . | string |
Endpoint URLhireright.endpoint.url | The URL of the Hireright endpoint https://api.hireright.com:11443/ws_gateway/HireRightAPI/v/1/2 | string |
Events Enabledevent.notification.enabled | Optional. Identifies that events are enabled for the element instance. Default: false . | boolean |
Filter null values from the responsefilter.response.nulls | Optional. Determines if null values in the response JSON should be filtered from the response. Yes or true indicates that Cloud Elements will filter null values.Default: true | boolean |
User Namehireright.username | Your HireRight user name | string |
Passwordhireright.password | Your HireRight password | string |
Account IDhireright.account.id | Your HireRight Account ID | string |
Company Loginhireright.company.login | Your HireRight Company Login | string |
User Ref IDhireright.user.ref.id | Your HireRight User Ref ID | string |
Callback Notification Signature Keyevent.notification.signature.key | A key used to generate a validation hash header of the event/bulk notification webhook callback payload | string |
Default Select Fieldsdefault.select.fields.map | Generic map used to specify default fields for bulk download and GET /all requests. Each key should be the canonical objectName and values may be specified as a comma-delimited string or a list of strings. |