Getting Started

Enabling Publications

Get in touch with your account manager to have Publications enabled on your site.

Onced enabled, you will have a new capability under User Management > Capabilities. Users accessing Publications will need to belong to a user group where the Publications and API capabilities are enabled.

Configuring Publications

Once the above steps are completed, you will navigate to Tools and select Publications from the menu bar. From here, you can configure, view, and modify your Publication topics

Default Publication Topics

You will see 3 default topics automatically available to you. These are available out of the box.

default-data - all data updates from the system (i.e. creating records, modifying records, deleting records)
default-schema - all system/schema updates made to Object Management of the site
default-users - all user/user-group updates made to User Management of the site

Default topics cannot be modified or deleted. You can consume from these topics if you're interested in consuming all data from DealCloud relevant to that event type. See more about event types here.

Custom Publication Topics

You also have the ability to create custom Publication topics. Custom topics allow you to select which objects and field updates you care about versus consuming all updates from the default-data topic. Only messages relevant to the selected objects & fields will get sent to your custom topic.

Click "Create Publication" and start choosing the objects. By default, all fields will be selected once you enable an object. Optionally, you can filter by fields and only include the fields you care about to recieve updates from.

Making Publication API Requests

Here's a sample workflow of calling the Publication APIs.

ℹ

Reminder: All Publication API calls happen based on the Publications URLs and not site-specific endpoints like the standard REST APIs.

Retrieve Token

First, call the token endpoint to retrieve an OAuth token. Note, the Publication APIs uses the same token as all other APIs. You must provide the scope publish when calling the token endpoint to generate a token that is authorized to call the Publication APIs.

Request Sample

POST {baseUrl}/api/rest/v1/oauth/token
Content-Type: application/x-www-form-urlencoded
 
scope=publish
&grant_type=client_credentials
&client_id=106
&client_secret=1356GYNU

Call GET /topics

Call the Topics endpoint to see a list of available topics. Replae pubURL with your Publications URLs

GET {pubUrl}/api/rest/v1/publication/topics
Authorization: {{auth}}

Poll a topic

Start a connection with a topic to begin recieving the events. Continue to poll this endpoint at the frequency and volume you may need. See more about our design reccomendations below.

Acknowledge Messages (Optional)

You may acknowledge messages once you've processed them so at the next connection, you will start from a new message.

Publications Topics