Publications
The Publication APIs enable real-time or near real-time event consumption from the DealCloud system. Messages are streamed to "Publication Topics" which can be called to retrieve events as they happen. These APIs are stateful and use sessions, unlike the standard REST APIs.
Use Cases
Publications can be leveraged for a variety of use-cases. Especially for high-volume, real-time, event-driven scenarios. Customers today leverage Publications for things like
- Powering their BI & reporting workflows
- Storing all DealCloud data events downstream for regulatory, compliance, SIEM needs
- Powering event-driven workflows to trigger proccesses & automations downstream
Retention Period
Publication events are published immediately and data is retained in topics for 9 days.
Accessing Publications
The Publication API endpoints are now site-specific, replacing the previous environment/region-based endpoint structure. The new endpoints are also available on the standard site Swagger page
To access the Publication APIs, visit your Publications page on DealCloud and click on the Open Swagger link at the top-right. This will open up the Swagger page for your DealCloud site.
Testing
Note that the Publication APIs are event-driven and stateful, unlike the standard REST APIs which are stateless. Therefore, when you attempt to test the API calls in a tool like Swagger or Postman, keep in mind that the response may only contain a limited number of events. Continuous polling of the APIs over a session will return subsequent events.