Link

Integrating With Cerkl

API Integrations can be difficult if you don’t fully understand the problem you’re trying to solve. Hopefully this documentation website eases your Cerkl development pains, but we understand every integration is different. To make the process of integrating Cerkl’s API into your codebase even easier, we have a few suggestions for how to structure your workflows.

In general, there are two types of integration work you might do to connect your CRM (customer relationship management) or HRIS (human resource information system): Subscriber integrations that can sync your Cerkl audience from your CRM/HRIS platform, and Content integrations that pull your communications content from various platforms into Cerkl for your personalized Newsletters.

Subscriber Integrations

When integrating Subscribers, you’re trying to establish a one-to-one relationship between contacts in your CRM/HRIS platform and your Cerkl Broadcast Audience. To enhance how your communications are targeted, our Segments offer a useful way to logically separate your Subscribers into groups. Our Dynamic Segments (which are only available in the Cerkl Broadcast UI) enable you to use the different attributes attached to each Subscriber to create Segments on the fly using logical rulesets that can be as simple or complex as you need them to be. These are distinct from our “normal” Segments that contain a static list of Subscribers that must be updated manually (which you can create both in the Cerkl Broadcast UI and via our API). We highly recommend taking a “Subscriber attributes first” approach that allows you to make use of our Dynamic Segments, as you can edit rulesets on the fly and generate new segmentations whenever you need to and without having to re-sync your entire Audience.

Adding a new Dynamic Segment in Cerkl Broadcast's UI
Adding a new Dynamic Segment in Cerkl Broadcast's UI

Taking advantage of our Dynamic Segments using Subscriber attributes is really pretty simple: just utilize the variety of fields we have available in our Subscriber model when you sync your Subscribers from your CRM/HRIS platform to Cerkl! If you view documentation on adding Subscribers you can see the minimum request body for adding a Subscriber to your Audience. If you view the POST /subscriber request in our API Reference, you will be able to see all of the additional fields available to you.

Content Integrations

Content integrations with Cerkl Broadcast are relatively straightforward. If pulling your Content into Cerkl via RSS or Atom feeds (via Content Sources) doesn’t accomplish what you need, then using our various Content-focused endpoints (/story, /event, /need) will allow you to supply all of the details about your Content that already exists in your other platform straight to your Cerkl Broadcast Content Queue or Drafts. Which Content details you supply will vary depending on the platform you use to author and/or publish your Content originally, but our API offers a simple interface from which to do so.

Cerkl Support

If you have more questions about Cerkl Broadcast API integrations of any shape or size, don’t hesitate to reach out to us at support@cerkl.com! Or use the help bot in the bottom right-hand corner of any Cerkl page for a quick answer. We also offer Cerkl Professional Services that will contract with you to build custom API integrations at a competitive rate.