--- title: How to Use RabbitMQ description: Learn how to configure RabbitMQ for your Content Catalyst Site --- [Skip to content](https://guide.contentcatalyst.com/how-to-use-rabbitmq#main-content) ![CC logo blue-1 (1)](https://guide.contentcatalyst.com/hs-fs/hubfs/CC%20logo%20blue-1%20(1).png?width=200&height=89&name=CC%20logo%20blue-1%20(1).png) - [Guide & Help](https://guide.contentcatalyst.com/) - [Main Website](https://contentcatalyst.com/) - [Go to Customer Portal](https://guide.contentcatalyst.com/tickets-view) Open main navigation Close main navigation - [Guide & Help](https://guide.contentcatalyst.com/) - [Main Website](https://contentcatalyst.com/) - [Go to Customer Portal](https://guide.contentcatalyst.com/tickets-view) - [Main Website](https://contentcatalyst.com/) [Main Website](https://contentcatalyst.com/) Learn all about the platform - There are no suggestions because the search field is empty. 1. [Guide & Help](https://guide.contentcatalyst.com/?hsLang=en) 2. [RabbitMQ](https://guide.contentcatalyst.com/rabbitmq?hsLang=en) 3. [How to Use Rabbit MQ](https://guide.contentcatalyst.com/rabbitmq?hsLang=en#how-to-use-rabbit-mq) # How to Use RabbitMQ ## The following article will cover the basics of using RabbitMQ for your Content Catalyst site. You can find comprehensive tutorials at [https://www.rabbitmq.com/](https://www.rabbitmq.com/#getstarted). We recommend reading the [core RabbitMQ concepts](https://www.rabbitmq.com/tutorials/amqp-concepts.html) and subscribing to a queue by following [tutorial 3](https://www.rabbitmq.com/tutorials/tutorial-three-dotnet.html). (Please remember that you will only be given a read-only login to read from a pre-configured queue - you won’t be able to declare the queue or bind it, so skip those steps in the tutorial when trying against the live server.) **🔔Note:** First, please contact support via [support@contentcatalyst.com](mailto:support@contentcatalyst.com) for the hostname and credentials to log in to our RabbitMQ instance. ### Queues RabbitMQ stores a copy of every message in a queue until the application is ready to receive it. We recommend having a separate queue for each integration, so that they each receive a copy of the message. Each message has a Time-To-Live (TTL) of 30 days. This is in line with the 30-day retention already published in the Client User Data and PII table for sent emails and notifications. If you consume events regularly this retention period won't affect you, but any messages that are left unactioned for 30 days will expire and will no longer be available. ### Topics Each queue you set up can be configured to listen to certain events - we use [topic routing](https://www.rabbitmq.com/tutorials/tutorial-five-dotnet.html) to make sure the queue only processes events relevant to it. Each message is tagged with a topic, such as **subscribers.requests.accountmanager** (this can be found in the message ‘RoutingKey’ property). If you wanted a queue to listen to all subscriber requests, you can request the topic subscribers.requests.\*. Alternatively, you can listen to all events by requesting the topic #. ### Message Structure ### Message Id Each event created by iReports will have a unique and persistent id. We provide this as a GUID (UUID) in the message property MessageId. A message can, in some circumstances, be delivered twice (or more): this can be OK for some types of messages, but for others, we expect clients to de-duplicate the message. ### Message Body By default, event messages are UTF8 encoded JSON strings. Each message is wrapped in an ‘Envelope’ with the following properties: ``` { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Message envelope", "description": "An envelope wrapping the message data, with standard properties shared between all messages.", "type": "object", "properties": { "version": { "type": "string", "description": "A semantic version ('semver') string describing the version of the message. See versioning below." }, "data": { "description": "The content of the event (format varies for each topic - read the documentation for each one)." }, "tenantId": { "description": "A string used by the Content Catalyst system - safe for you to ignore.", "type": "string" }, "createdDate": { "description": "The date/time when the event was triggered.", "type": "string", "format": "date-time" }, "creator": { "description": "The username of the user who triggered the event. (Can be null if a system event or an unauthenticated (anonymous) user). Subscribers should ignore events with their own username, so that infinite loops don't occur.", "type": "string" } } } ``` Unless otherwise specified, the JSON follows these conventions: ### Versioning All messages contain a semantic version number for the message, in the form of “X.Y.Z” where X is the major version, Y is the minor version, and Z is the patch version. When a major change is necessary, both the current major version and the next major version of a message will be added to the queue, so that dependent services can be updated. Because of this, you should ignore messages with major versions which your application does not know about. The old major version of the message will be removed after the notice period. When a minor change is necessary, such as adding a new message or a property to an existing message, the minor or patch versions will be incremented as appropriate. There is no dual-running period of messages for minor changes, so your application should usually ignore the minor or patch version number. ### Example clients Clients for RabbitMQ can be written in many different programming languages. Here is a basic example C# console program that will connect to a queue and print any messages it receives: ``` ```       - [Setting Up Your Content Catalyst Subscriber Portal](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#main-content) - [Onboarding](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#onboarding) - [Site Options](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#site-options) - [Showcase Page](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#showcase-page) - [Export Template Customisation & Branding](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#export-template-customisation-branding) - [Site Design & Branding](https://guide.contentcatalyst.com/setting-up-your-content-catalyst-subscriber-portal?hsLang=en#site-design-branding) - [Site Authentication & User Registration](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#main-content) - [Site Access](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#site-access) - [User Registration](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#user-registration) - [SSO](https://guide.contentcatalyst.com/site-authentication-user-registration?hsLang=en#sso) - [Account & User Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#main-content) - [Account Creation & Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#account-creation-management) - [User Creation & Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#user-creation-management) - [Security](https://guide.contentcatalyst.com/account-user-management?hsLang=en#security) - [Account Manager Creation & Management](https://guide.contentcatalyst.com/account-user-management?hsLang=en#account-manager-creation-management) - [Guest Access](https://guide.contentcatalyst.com/account-user-management?hsLang=en#guest-access) - [Licensing & Access Management](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#main-content) - [Creating & Managing Licenses](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#creating-managing-licenses) - [Prevent Full Downloads](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#prevent-full-downloads) - [Remote Access](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#remote-access) - [Restrict Export Formats](https://guide.contentcatalyst.com/licensing-access-management?hsLang=en#restrict-export-formats) - [Organise, Categorise, and Link Content](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#main-content) - [Creating & Managing Category Trees](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#creating-managing-category-trees) - [Configuring Category Landing Pages](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#configuring-category-landing-pages) - [Category & Report Covers](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#category-report-covers) - [Chapters & Sections](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#chapters-sections) - [Analysts](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#analysts) - [Tags](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#tags) - [Report Series & Linked Reports](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#report-series-linked-reports) - [Promote Categories](https://guide.contentcatalyst.com/organise-categorise-and-link-content?hsLang=en#promote-categories) - [Create & Deliver Content and Data](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#main-content) - [Report Metadata](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#report-metadata) - [Importing Content](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#importing-content) - [Instant Insights/Briefings](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#instant-insights-briefings) - [Interactive Docs](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#interactive-docs) - [DocuViewer](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#docuviewer) - [PDF/SlideViewer](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#pdf-slideviewer) - [Power BI](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#power-bi) - [Video Content](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#video-content) - [External Reports](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#external-reports) - [Publishing Workflow](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#publishing-workflow) - [DataViewer](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#dataviewer) - [RSS Feeds](https://guide.contentcatalyst.com/create-deliver-content-and-data?hsLang=en#rss-feeds) - [Operations & Administration support](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#main-content) - [Domain Configuration](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#domain-configuration) - [Email Deliverability](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#email-deliverability) - [Search Configuration](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#search-configuration) - [Chargeback Codes](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#chargeback-codes) - [Policies & Notices](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#policies-notices) - [API](https://guide.contentcatalyst.com/operations-administration-support?hsLang=en#api) - [Site Extensions & Integrations](https://guide.contentcatalyst.com/site-extensions-integrations?hsLang=en#main-content) - [CRM Integrations](https://guide.contentcatalyst.com/site-extensions-integrations?hsLang=en#crm-integrations) - [Integrations](https://guide.contentcatalyst.com/site-extensions-integrations?hsLang=en#integrations) - [Tracking & Analytics of Subscriber Use](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#main-content) - [General](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#general) - [Report Access](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#report-access) - [Popular Searches](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#popular-searches) - [Tracking Snippets](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#tracking-snippets) - [Account Statistics](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#account-statistics) - [Analytics Sales Leads](https://guide.contentcatalyst.com/tracking-analytics-of-subscriber-use?hsLang=en#analytics-sales-leads) - [Sales & Marketing](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#main-content) - [Email Customisation & Branding](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#email-customisation-branding) - [Buy It Now](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#buy-it-now) - [Instant Access Links](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#instant-access-links) - [Search Engine Verification](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#search-engine-verification) - [Trials](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#trials) - [Personalised Content Notifications](https://guide.contentcatalyst.com/sales-marketing?hsLang=en#personalised-content-notifications) - [Content Discovery](https://guide.contentcatalyst.com/content-discovery?hsLang=en#main-content) - [Site Navigation](https://guide.contentcatalyst.com/content-discovery?hsLang=en#site-navigation) - [End-User Search](https://guide.contentcatalyst.com/content-discovery?hsLang=en#end-user-search) - [Categories & Tags](https://guide.contentcatalyst.com/content-discovery?hsLang=en#categories-tags) - [MyCatalyst](https://guide.contentcatalyst.com/content-discovery?hsLang=en#mycatalyst) - [End-User Actions](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#main-content) - [Share Briefing](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#share-briefing) - [Ask The Analyst](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#ask-the-analyst) - [Collate & Export Content](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#collate-export-content) - [Share](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#share) - [Notes](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#notes) - [Translation](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#translation) - [User Profile](https://guide.contentcatalyst.com/end-user-actions?hsLang=en#user-profile) - [RabbitMQ](https://guide.contentcatalyst.com/rabbitmq?hsLang=en#main-content) - [How to Use Rabbit MQ](https://guide.contentcatalyst.com/rabbitmq?hsLang=en#how-to-use-rabbit-mq) - [RabbitMQ: Events](https://guide.contentcatalyst.com/rabbitmq?hsLang=en#rabbitmq-events) - [Main Website](https://contentcatalyst.com/) - [Go to Customer Portal](https://guide.contentcatalyst.com/tickets-view) - [Release Notes](https://guide.contentcatalyst.com/release-notes) - [Raise a Ticket](https://guide.contentcatalyst.com/tickets-view/new?) [![CC logo blue-1 (1)](https://guide.contentcatalyst.com/hs-fs/hubfs/CC%20logo%20blue-1%20(1).png?width=100&height=44&name=CC%20logo%20blue-1%20(1).png "CC logo blue-1 (1)")](http://contentcatalyst.com) Energise your insights Copyright © 2025, Content Catalyst Ltd.