Skip to content
  • There are no suggestions because the search field is empty.

RabbitMQ Events: Changes to Category Licenses

The article below will detail what can be seen in the Changes to Category licenses related events in your Content Catalyst RabbitMQ feed.

The following events are available:

Category licenses added

license.category.changes.added

Sent when a category license, for an account or user, is added. The state of the new category license can be retrieved with a GET from ~/api/v1/licenses/{licenseId}.

Message Body

{
     "$schema": "http://json-schema.org/draft-04/schema#",
     "type": "object",
     "properties": {
         "id": {
             "type": "integer",
             "description": "The id of the license added"
         }
     }
 }

Category license updated

license.category.changes.updated

Sent when a category license, for an account or user, is updated. Only the date of a license can be updated once it has been created. The state of the updated category license can be retrieved with a GET from ~/api/v1/licenses/{licenseId}.

No message is sent when a license expires or comes into effect due to its end or start date passing. A message will also not be sent if a report is added or removed from a category.

Changes to the category tree can also effect licenses but no license.category.changes.updated message will be sent.

A Changes to categories message will be sent however and the category ids referenced by the license properties and will need to be resynced with the APIs.

Message Body

{
     "$schema": "http://json-schema.org/draft-04/schema#",
     "type": "object",
     "properties": {
         "id": {
             "type": "integer",
             "description": "The id of the license updated"
         }
     }
 }

Category licenses removed

license.category.changes.removed

Sent when a category license, for an account or user, is removed through the UI or API. When this happens, the license can be got by calling ~/api/v1/licenses/{licenseId}.

🔔Note:  Licenses can also be removed (but no license.category.changes.removed message sent) when:

  • Changes to accounts  

    Message: account.changes.removedLicense properties: Must be tracked locally as they are no longer available through the API. 
    Licenses with an account name matching the account name in the message will have been deleted (user- level licenses also specify account name and will match this condition).

    Message: account.changes.categoryLicensesRemoved
    License properties: Must be tracked locally as they are no longer available through the API. Licenses with an account name matching the account name in the message will have been deleted (user level licenses also specify account name and will match this condition)
  • Changes to users and user activity

    Message: subscriber.changes.removedLicense properties: Can be found at ~/api/v1/licenses/{licenseId}. 
    Licenses must be tracked locally to retrieve the license ID. Licenses with a username matching the username in the message will have been deleted.

    Message: subscriber.changes.categoryLicensesRemovedLicense properties: Must be tracked locally as they are no longer available through the API. Licenses with a username matching the username in the message will have been deleted
  • Category deleted

    Message: category.changesLicense properties: Can be found at ~/api/v1/licenses/{licenseId}.  Licenses must be tracked locally to retrieve the license Id. Licenses for a category which was deleted will also be deleted

Message Body

{
     "$schema": "http://json-schema.org/draft-04/schema#",
     "type": "object",
     "properties": {
         "id": {
             "type": "integer",
             "description": "The id of the removed license"
         }
     }
 }