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 GitHub. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance.

After you follow the steps below to authenticate an element instance with webhooks, be sure to follow the steps in Configure Webhooks at GitHub to finish the setup. For more information about webhooks at GitHub including the currently available webhooks, see GitHub's webhooks documentation.

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 GitHub .
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.
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 GitHub, and then allow the connection.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual resource, or use it in a formula template.

Configure Webhooks Through API

Use the /instances endpoint to authenticate with GitHub 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": "github"
     },
     "providerData": {
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration": {
       "oauth.api.key": "<GitHub app Client ID>",
       "oauth.api.secret": "<GitHub app Client Secret>",
       "oauth.callback.url": "<GitHub app Authorization callback URL >",
       "github.organization": "<github.organization>",
       "github.repository": "<github.repository>",
       "event.notification.enabled": true,
       "event.vendor.type": "webhooks",
       "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.

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": "github"
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "oauth.api.key": "Rand0MAP1-key",
    "oauth.api.secret": "fak3AP1-s3Cr3t",
    "oauth.callback.url": "https://mycoolapp.com",
    "github.organization": "myOrg",
    "github.repository": "myRepo"
    "event.notification.enabled": true,
    "event.vendor.type": "webhooks",
    "event.notification.callback.url": "https://mycoolapp.com/events",
    "event.notification.signature.key": "xxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

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

Configure Webhooks at GitHub

After you authenticate an element instance with webhooks, you must set up webhooks at GitHub. Take a look at their documentation for complete details.

1. Retrieve the Webhook URL from the element instance.
   • Navigate to the element instance, click Edit on the element instance card, and then copy the Webhook URL.
   • Make a GET/instances/{id}/events request and look for encodedid in the response. Append that to theevent.notification.callback.url you used when authenticating the element instance. This is the Webhook URL.
2. Go to your repository in Github, and then click the Settings tab.
3. On the left, click Webhooks.
4. Click Add webhook.
5. In Payload URL, enter the Webhook URL you identified in step 1.
6. Change the Content Type to application/json.
7. Complete the form as needed for your use case, and then click Add Webhook.