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 Egnyte. 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 Egnyte 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":"egnyte" }, "providerData":{ "code": "<AUTHORIZATION_GRANT_CODE>" }, "configuration":{ "oauth.callback.url": "<CALLBACK_URL>", "oauth.api.key": "<CONSUMER_KEY>", "oauth.api.secret": "<CONSUMER_SECRET>", "subdomain": "<YOUR_SUBDOMAIN>", "event.notification.enabled": true, "event.notification.callback.url": "http://mycoolapp.com", "event.poller.refresh_interval": "<minutes>", "event.poller.configuration":{ "events":{ "url":"/hubs/documents/events", "idField":"event_object_id", "datesConfiguration":{ "updatedDateField":"event_date", "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSSX", "updatedDateTimezone":"GMT", "createdDateField":"event_date", "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSSX'", "createdDateTimezone":"GMT" } } } }, "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 JSON with Polling
instance JSON with polling events enabled:
{
"element":{
"key":"egnyte"
},
"providerData":{
"code":"1c6ff4089d58d80e86482ab7d5b97f15dd7b041d"
},
"configuration":{
"oauth.callback.url": "https://mycoolapp.com",
"oauth.api.key": "xxxxxxxxxxxxxxxxxxxxxxx",
"oauth.api.secret": "xxxxxxxxxxxxxxxxxx",
"subdomain":"cloudelements",
"event.notification.enabled":true,
"event.notification.callback.url":"http://mycoolapp.com",
"event.poller.refresh_interval":"15",
"event.poller.configuration":{
"events":{
"url":"/hubs/documents/events",
"idField":"event_object_id",
"datesConfiguration":{
"updatedDateField":"event_date",
"updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSSX",
"updatedDateTimezone":"GMT",
"createdDateField":"event_date",
"createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss.SSSX'",
"createdDateTimezone":"GMT"
}
}
}
},
"tags":[
"Test"
],
"name":"API_Polling"
}
Parameters
API parameters not shown in SAP Open Connectors are in code formatting
.
Parameter | Description | Data Type |
---|---|---|
key | The connector key. egnyte | string |
code | The authorization grant code returned from the API provider in an OAuth2 authentication workflow. | string |
Namename | The name for the connector instance created during authentication. | Body |
oauth.callback.url | The Callback URL for the connected app you created for Egnyte. This is the Callback URL that you recorded in API Provider Setup section. | |
oauth.api.key | The key obtained from registering your app with the provider. This is the Client ID that you recorded in API Provider Setup section. | string |
oauth.api.secret | The client secret obtained from registering your app with the provider. This is the Client Secret that you recorded in API Provider Setup section. | string |
The Egnyte Subdomainsubdomain | The Egnyte Domain which appears in the URL between https:// and egnyte.com . For example, the SAP Open Connectors Egnyte Domain in https://cloudelements.egnyte.com is cloudelements . | string |
Events Enabledevent.notification.enabled | Optional. Identifies that events are enabled for the connector instance. Default: false . | boolean |
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 |
Configure Pollingevent.poller.configuration | Optional*. Configuration parameters for polling. | JSON object |
events | The configuration of the events resource. | JSON object |
URLurl | The url to query for updates to the resource. | String |
ID FieldidField | The field in the resource that is used to uniquely identify it. | String |
Advanced FilteringdatesConfiguration | Configuration parameters for dates in polling | JSON Object |
Updated Date FieldupdatedDateField | The field that identifies an updated object. | String |
Updated Date FormatupdatedDateFormat | The date format of the field that identifies an updated object. | String |
Created Date FieldcreatedDateField | The field that identifies a created object. | String |
Created Date FormatcreatedDateFormat | The date format of the field that identifies a created object. | String |
tags | Optional. User-defined tags to further identify the instance. | string |