Today we’re announcing that the APIs for the Heroku Connect data synchronization service are now GA. These fully supported endpoints will help our users with the tasks they most need repeatable automation for: creating consistent configuration across development, staging, and production environments; managing connections across multiple Salesforce deployments; and integrating Heroku Connect status with their existing operational systems and alerts.
When we first released Heroku Connect, users were delighted with the simple point and click UI: they could suddenly integrate Salesforce data with Heroku Postgres in one enjoyable minute! But as users’ familiarity with the service has grown and their use cases have become more sophisticated, we’ve heard increasing demand for the APIs that would help users drive the service programmatically. A common request from partners, ISVs, and multi-org operators has been an endpoint they can use to check status for every mapping on every connection and tune their operational monitoring accordingly.
The APIs now in GA are focused on the core operations of Heroku Connect: creating an authenticated connection between a Salesforce deployment and Heroku Postgres, configuring the data mappings, reload/restart/pause, and retrieving synchronization status. Any connection instantiated and managed via the API may also be accessed via the Heroku Connect UI. Some context is provided only in the docs or the UI, such as detailed explanations of service behavior in polling vs. streaming mode.
Full documentation of Heroku Connect and the APIs is available on the Heroku Dev Center. We recommend you use the APIs via the Heroku Toolbelt. There is connection level throttling in place: 5,000 calls a day, plus a 100 calls/day limitation on “Poll Now.” The “Poll Now” call is very handy for development purposes when you want to test whether data is moving, but not intended to replace the deliberately tuned sync frequency settings.
We’ve also published a new Supported Objects app that describes which Salesforce objects are fully supported by their Salesforce API version. While the Dev Center docs explain that certain objects (such as those without SystemModStamp) load successfully but do not sync, the list and search functions on the app reduce the need to read the documentation in favor of a fast answer for a specific object.
We are looking forward to continuing the buildout of the APIs based on feedback from the Salesforce Heroku developer community. Getting started is easy, we’ve included a step-by-step walk through in the docs. Requests for updates, modifications, new endpoints and other features are always welcome via support tickets or feedback on the Dev Center docs.