Greenhouse Events

On this page

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 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 their webhooks documentation.

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

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

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

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. 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 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.


ParameterDescriptionData Type
keyThe element key.
greenhouse
string
API Key
api.key
The Greenhouse Harvest API Key that you noted in API Provider Setup.string
Events Enabled
event.notification.enabled
Optional. Identifies that events are enabled for the element instance.
Default: false.
boolean
Event Notification Callback URL
event.notification.callback.url
The URL where you want Cloud Elements 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
tagsOptional. User-defined tags to further identify the instance.string

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. webhook setup
  5. Click Create Webhook.