Events

Cloud Elements supports events via polling or webhooks depending on the API provider. If you would like to see more information on our Events framework, please see the Event Management Guide.

Supported Events and Resources

Cloud Elements supports webhook events for Greenhouse. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance. For more information about webhooks at Greenhouse including the currently available webhooks, see Greenhouse's webhooks documentation.

After you set up webhook events in Cloud Elements, you also need to configure webhooks at Greenhouse with the Webhook URL provided after authentication. See Webhook Configuration.

Webhooks

You can configure webhooks through the UI or in the JSON body of the /instances API request .

Configure Webhooks Through the UI

For more information about each field described here, see Parameters.

To authenticate an element instance with webhooks:

1. Enter the basic information required to authenticate an element instance as described in Authenticate with Greenhouse .
2. To enable hash verification in the headers of event callbacks, click Show Optional Fields, and then add a key to Callback Notification Signature Key.
3. Enable events: Switch Events Enabled on.
4. Add an Event Notification Callback URL such as https://api.cloud-elements.com/elements/api-v2/events/greenhouse/ (the default).
5. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
6. Click Create Instance.
7. Log in to Greenhouse, and then allow the connection.

After successfully authenticating, open the authenticated instance that you just created, and then copy the Webhook URL. You'll use the url to configure webhooks at Greenhouse.

Configure Webhooks Through API

Use the /instances endpoint to authenticate with Greenhouse and create an element instance with webhooks enabled.

To authenticate an element instance with webhooks:

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": "greenhouse"
     },
     "configuration": {
       "api.key": "<Greenhouse Harvest API Key>",
       "event.vendor.type": "webhooks",
       "event.notification.enabled": true,
       "event.notification.callback.url": "<CALLBACK_URL>",
       "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>"
     },
     "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. See the Overview for details.

4. Locate the token and id in the response and save them for all future requests using the element instance.

5. Get the Webhook URL needed to configure webhooks at Greenhouse by logging in to Cloud Elements 2.0. Open your new instance and copy the Webhook URL.

6. Set up [webhooks at the API provider][#webhook-configuration].

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "greenhouse"
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "api.key": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "event.vendor.type": "webhooks",
    "event.notification.enabled": true,
    "event.notification.callback.url": "https://api.cloud-elements.com/elements/api-v2/events/greenhouse/",
    "event.notification.signature.key": "8e98fjke8jek",
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

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

Webhook Configuration

Use the Webhook URL we generated after you authenticated the element Instance to set up webhooks at Greenhouse. Before you begin, review the Greenhouse documentation on webhooks.

1. Log in to your account at Greenhouse.
2. Click the Settings icon at the top of the page, or click the Configure tab.
3. Open the Dev Center: click Dev Center in the list on the left or the link on the Configure page.
4. Click Web Hooks, and then click Web Hooks on more time. 5.Complete the Create A New Web Hook form, entering the Webhook URL from Cloud Elements in the Endpoint URL box.
5. Click Create Webhook.