SAP Cloud Platform Open Connectors

Hootsuite Events

SAP Cloud Platform Open Connectors 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

SAP Cloud Platform Open Connectors supports webhook events for Hootsuite. After receiving an event, SAP Cloud Platform Open Connectors standardizes the payload and sends an event to the configured callback URL of your authenticated connector instance. For more information about webhooks at Hootsuite 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 a connector instance, and then turn on events. For more information, see Authenticate an Connector Instance with Events (UI) or the connector-specific authentication topic.

Configure Webhooks Through API

Use the /instances endpoint to authenticate with Hootsuite and create a connector instance with webhooks enabled.

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

To authenticate a connector 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.openconnectors.us2.ext.hana.ondemand.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 connector 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. 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 connector instance.

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

Example cURL

curl -X POST \
  https://api.openconnectors.us2.ext.hana.ondemand.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 SAP Cloud Platform Open Connectors are in code formatting.


ParameterDescriptionData Type
keyThe connector key.
hootsuite
string
codeThe authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow.string
Name
name
The name for the connector instance created during authentication.string
oauth.callback.urlThe URL where you want to redirect users after they grant access. This is the API Callback URL that you noted in the API Provider Setup section.string
oauth.api.keyThe REST API Client ID from Hootsuite. This is the REST API Client ID that you noted in the API Provider Setup section.string
oauth.api.secretThe REST API Client Secret from Hootsuite. This is the REST API Client Secret that you noted in the API Provider Setup section.string
Events Enabled
event.notification.enabled
Optional. Identifies that events are enabled for the connector instance.
Default: false.
boolean
Event Notification Callback URL
event.notification.callback.url
The URL where you want SAP Cloud Platform Open Connectors to send the events. This is the Webhook URL that you noted in the API Provider Setup section.string
tagsOptional. User-defined tags to further identify the instance.string