Recurly Events | Cloud Elements Help Center

Cloud Elements 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

Cloud Elements supports polling events for Recurly. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element 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 an element instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Polling Through API

Use the /instances endpoint to authenticate with Recurly and create an element instance with polling enabled.

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

To authenticate an element instance with polling:

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

{
  "element": {
    "key": "recurly"
  },
  "configuration": {
    "subdomain": "<INSERT_SUBDOMAIN>",
    "ApiVersion": "<INSERT_APIVERSION>",
    "recurly.api.key": "<INSERT_RECURLY_API_KEY>",
    "event.notification.enabled": true,
    "event.notification.callback.url": "http://mycoolapp.com",
    "event.poller.refresh_interval": "<minutes>",
    "event.poller.configuration": {
      "customers": {
        "url": "/hubs/billing/customers?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at' ",
        "idField": "account_code",
        "datesConfiguration": {
          "updatedDateField": "lastModifiedOn",
          "updatedDateFormat": "milliseconds",
          "createdDateField": "createdOn",
          "createdDateFormat": "milliseconds",
          "createdDateTimezone": "GMT",
          "updatedDateTimezone": "GMT"
        },
        "invoices": {
          "url": "/hubs/billing/invoices?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "uuid",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        },
        "plans": {
          "url": "/hubs/billing/plans?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "plan_code",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        },
        "subscriptions": {
          "url": "/hubs/billing/subscriptions?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "uuid",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        },
        "transactions": {
          "url": "/hubs/billing/transactions?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "uuid",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        }
      }
    }
  },
  "tags": [
    "<INSERT_YOUR_TAGS>"
  ],
  "name": "<INSERT_INSTANCE_NAME>"
}

Call the following, including the JSON body you constructed in the previous step:
```
POST /instances
```

Example JSON with Polling

instance JSON with polling events enabled:

{
  "element": {
    "key": "recurly"
  },
  "configuration": {
    "subdomain": "mycooldomain",
    "ApiVersion": "2.5",
    "recurly.api.key": "<4hiopfsfay8y89f218fFHE4D82h",
    "event.notification.enabled": true,
    "event.notification.callback.url": "http://mycoolapp.com",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration": {
      "customers": {
        "url": "/hubs/billing/customers?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at' ",
        "idField": "account_code",
        "datesConfiguration": {
          "updatedDateField": "lastModifiedOn",
          "updatedDateFormat": "milliseconds",
          "createdDateField": "createdOn",
          "createdDateFormat": "milliseconds",
          "createdDateTimezone": "GMT",
          "updatedDateTimezone": "GMT"
        },
        "invoices": {
          "url": "/hubs/billing/invoices?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "uuid",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        },
        "plans": {
          "url": "/hubs/billing/plans?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "plan_code",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        },
        "subscriptions": {
          "url": "/hubs/billing/subscriptions?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "uuid",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        },
        "transactions": {
          "url": "/hubs/billing/transactions?where=begin_time='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' AND sort='updated_at'",
          "idField": "uuid",
          "datesConfiguration": {
            "updatedDateField": "lastModifiedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "createdOn",
            "createdDateFormat": "milliseconds",
            "createdDateTimezone": "GMT",
            "updatedDateTimezone": "GMT"
          }
        }
      }
    }
  },
  "tags": [
    "APIInstance"
  ],
  "name": "MyCoolInstance"
}

Parameters

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

Parameter	Description	Data Type
`key`	The element key. recurly	string
Name `name`	The name for the element instance created during authentication.	Body
Subdomain `subdomain`	Your account's Recurly subdomain, which you noted in Recurly API Provider Setup.	string
Recurly API Key `recurly.api.key`	The private API key generated and noted during Recurly API Provider Setup.	string
API Version `apiversion`	The version of the Recurly API you want to set. The default value is `2.5`; use that value unless you have a specific use case to do so.	string
Events Enabled `event.notification.enabled`	Optional. Identifies that events are enabled for the element instance. Default: `false`.	boolean
Event Notification Callback URL `event.notification.callback.url`	The URL where you want Cloud Elements 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
employees	The polling event configuration of the employees resource.	JSON object
URL `url`	The url to query for updates to the resource.	String
ID Field `idField`	The field in the resource that is used to uniquely identify it.	String
Advanced Filtering `datesConfiguration`	Configuration parameters for dates in polling	JSON Object
Updated Date Field `updatedDateField`	The field that identifies an updated object.	String
Updated Date Format `updatedDateFormat`	The date format of the field that identifies an updated object.	String
Created Date Field `createdDateField`	The field that identifies a created object.	String
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