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 Hootsuite. For more information about webhooks at Hootsuite including the currently available webhooks, see Hootsuite'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. Complete the authentication steps in Authenticate with Hootsuite.
2. Enable events: Switch Events Enabled on.

3. Add an Event Notification Callback URL.

   Note: When you first authenticate the element instance, enter a placeholder URL such as https://api.cloud-elements.com/elements/api-v2/events/hootsuite. After you update the Webhook URL in Hootsuite, you can update the instance with the complete URL including the Base 64 encoded Element ID.

4. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.

5. Click Create Instance.

6. Provide your Hootsuite credentials, and then allow the connection.

7. Use a Base 64 encoding tool, such as [Base64(https://www.base64encode.org/)], to encode the element ID.

8. Follow the steps in API Provider Setup to define the Webhook URL at Hootsuite.

9. Update the Event Notification Callback URL in the element instance: Open the element instance for editing, change the Event Notification Callback URL, and then click Update.

Configure Webhooks Through API

Use the /instances endpoint to authenticate with Hootsuite 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": "hootsuite"
     },
     "providerData": {
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration": {
       "oauth.callback.url": "<CALLBACK_URL>",
       "oauth.api.key": "<CONSUMER_KEY>",
       "oauth.api.secret": "<CONSUMER_SECRET>",
       "event.notification.enabled": true,
       "event.notification.callback.url": "<CALLBACK_URL>"
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   
   

   Note: For event.notification.callback.url enter a placeholder URL such as https://api.cloud-elements.com/elements/api-v2/events/hootsuite. After you update the Webhook URL in Hootsuite, you can update the instance with the complete URL including the Base 64 encoded Element ID.

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. Use a Base 64 encoding tool, such as [Base64(https://www.base64encode.org/)], to encode the element ID.

6. Follow the steps in API Provider Setup to define the Webhook URL at Hootsuite.

7. Use PATCH /instances to update the event.notification.callback.url in 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": "hootsuite"
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "oauth.callback.url": "https://mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxx"
    "event.notification.enabled": true,
    "event.notification.callback.url": "https://mycoolapp.com/events"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

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