On this page
SAP 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 Open Connectors supports polling events for Google Drive. After receiving an event, SAP Open Connectors standardizes the payload and sends an event to the configured callback URL of your authenticated connector instance.
You can set up polling for the events
resource. You can also copy the events
configuration to poll other resources. See Configure Polling Through API for more information.
Configure Polling Through the UI
To configure polling through the UI, follow the same steps to authenticate a connector instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Connector Instance with Events (UI) or the connector-specific authentication topic.
Configure Polling Through API
Use the /instances
endpoint to authenticate with Google Drive and create a connector instance with polling enabled.
To authenticate a connector instance with polling:
- Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.
Construct a JSON body as shown below (see Parameters):
{ "element":{ "key":"googledrive" }, "providerData":{ "code": "<AUTHORIZATION_GRANT_CODE>" }, "configuration":{ "oauth.callback.url": "<CALLBACK_URL>", "oauth.api.key": "<CONSUMER_KEY>", "oauth.api.secret": "<CONSUMER_SECRET>", "document.root.folder.name": "<DIRECTORY_NAME>", "event.notification.enabled": true, "event.vendor.type": "polling", "event.notification.callback.url": "http://mycoolapp.com", "event.poller.refresh_interval": "<minutes>" }, "tags":[ "<Add_Your_Tag>" ], "name":"<INSTANCE_NAME>" }
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.Locate the
token
andid
in the response and save them for all future requests using the connector instance.
Example cURL with Polling
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": "googledrive"
},
"providerData":{
"code": "<AUTHORIZATION_GRANT_CODE>"
},
"configuration": {
"oauth.callback.url": "http://mycoolapp.com",
"oauth.api.key": "xxxxxxxxxxxxxxxxxx",
"oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
"document.root.folder.name": "My Drive",
"event.notification.enabled": true,
"event.vendor.type": "polling",
"event.notification.callback.url": "https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/events/googledrive/",
"event.poller.refresh_interval": "15"
},
"tags": [
"Docs"
],
"name": "API Instance with Polling"
}'
Parameters
API parameters not shown in SAP Open Connectors are in code formatting
.
Parameter | Description | Data Type |
---|---|---|
'key' | The connector key. googledrive | string |
Namename | The name for the connector instance created during authentication. | Body |
oauth.callback.url | The Callback URL that was registered when creating credentials in your Google Drive project. This is the Callback URL that you noted at the end of the API Provider Setup section. | |
oauth.api.key | The OAuth Client ID from Google Drive. This is the Client ID that you noted at the end of the API Provider Setup section. | string |
oauth.api.secret | The OAuth Client Secret from Google Drive. This is the Client Secret that you noted at the end of the API Provider Setup section. | string |
Document Root Folderdocument.root.folder.name | The directory on Google Drive that contains the documents that you want to connect. | string |
Events Enabledevent.notification.enabled | Optional. Identifies that events are enabled for the connector instance. Default: false . | boolean |
Event Typeevent.vendor.type | Optional. The event type used to monitor events. Polling is the default and only supported event type for Google Drive. | string |
Event Notification Callback URLevent.notification.callback.url | The URL where you want SAP Open Connectors to send the events. | string |
Event poller refresh interval (mins)event.poller.refresh_interval | A number in minutes to identify how often the poller should check for changes. | number |
Callback Notification Signature Keyevent.notification.signature.key | Optional. A user-defined key for added security to show that events have not been tampered with. | string |
tags | Optional. User-defined tags to further identify the instance. | string |