Sage CRM Events

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 Sage CRM. 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.

Note: Unless configured for a specific time zone, polling occurs in UTC.

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 Sage CRM and create a connector instance with polling 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 polling:

Construct a JSON body as shown below (see Parameters):

{
  "element":{
    "key":"sagecrm"
  },
  "configuration":{
    "subdomain": "sagecrm-0.<YOUR_TENANT>.com",
    "username": "<YOUR_USERNAME>",
    "password": "<YOUR_PASSWORD>",
    "event.notification.enabled": true,
    "event.notification.callback.url": "https://console.cloud-elements.com",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration":{
        "accounts": {
            "url": "/hubs/crm/accounts?where=Comp_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Comp_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "Comp_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "contacts": {
            "url": "/hubs/crm/contacts?where=Pers_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Pers_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "Pers_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "leads": {
            "url": "/hubs/crm/leads?where=Lead_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Lead_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "lead_createddate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "opportunities": {
            "url": "/hubs/crm/opportunities?where=Oppo_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Oppo_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "Oppo_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "users": {
            "url": "/hubs/crm/users?where=User_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "User_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "User_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "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 and id 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": "sagecrm"
  },
  "configuration": {
    "subdomain": "sagecrm-0.cloud-elements.com",
    "username": "xxxxx",
    "password": "xxxxxxxxxxxxxxxxxxxxxx",
    "event.notification.enabled": true,
    "event.notification.callback.url": "https://console.cloud-elements.com",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration":{
        "accounts": {
            "url": "/hubs/crm/accounts?where=Comp_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Comp_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "Comp_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "contacts": {
            "url": "/hubs/crm/contacts?where=Pers_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Pers_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "Pers_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "leads": {
            "url": "/hubs/crm/leads?where=Lead_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Lead_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "lead_createddate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "opportunities": {
            "url": "/hubs/crm/opportunities?where=Oppo_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "Oppo_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "Oppo_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        },
        "users": {
            "url": "/hubs/crm/users?where=User_UpdatedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField": "key",
            "datesConfiguration": {
                "updatedDateField": "User_UpdatedDate",
                "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "updatedDateTimezone": "GMT",
                "createdDateField": "User_CreatedDate",
                "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
                "createdDateTimezone": "GMT"
            }
        }
      }
  },
  "tags": [
    "Docs"
  ],
  "name": "SageCRMPolling"
}

Parameters

API parameters not shown in SAP Open Connectors are in code formatting.

Parameter	Description	Data Type
'key'	The connector key. sagecrm	string
Name `name`	The name for the connector instance created during authentication.	string
Subdomain `subdomain`	The subdomain portion of your Sage CRM URL, excluding HTTPS://	string
Username `username`	Your Sage CRM user name.	string
Password `password`	Your Sage CRM password.	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 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 Polling `event.poller.configuration`	Optional*. Configuration parameters for polling.	JSON object
<resource name> (e.g., accounts, contacts, or lists)	The polling configuration of the resource.	JSON object
<resource name>URL `url`	The url to query for updates to the resource.	String
<resource name>ID Field `idField`	The field in the resource that is used to uniquely identify it.	String
<resource name>Advanced Filtering `datesConfiguration`	Configuration parameters for dates in polling	JSON Object
<resource name>Updated Date Field `updatedDateField`	The field that identifies an updated object.	String
<resource name>Updated Date Format `updatedDateFormat`	The date format of the field that identifies an updated object.	String
<resource name>Created Date Field `createdDateField`	The field that identifies a created object.	String
<resource name>Created Date Format `createdDateFormat`	The date format of the field that identifies a created object.	String
tags	Optional. User-defined tags to further identify the instance.	string

SAP Open Connectors

Supported Events and Resources

Configure Polling Through the UI

Configure Polling Through API

Example JSON with Polling

Parameters

Related Information