Skip to main content
Browse Documentation
HTTP - Management

Topic

Created by c.neale, last modified by zengenti on 07 Apr 2021

A topic resource contains the information which will determine the specific events that a webhook subscription will be notified of.

Remarks

Topics schema

Resource type Associated topic properties Notes
entry/asset
  • event
    • created
    • updated
    • deleted
    • published
    • workflowStateChanged
    • workflowEventRaised
  • id
  • language
  • contentTypeId
  • dataFormat
  • owner
  • workflowState
  • workflowEvent
  • translationAvailable

Semi-dependent parameters:

  • workflowStateChanged => workflowState
  • workflowEventRaised => workflowEvent
contentType/component
  • event
    • created
    • updated
    • deleted
 
node
  • event
    • created
    • updated
    • deleted
 
project
  • event
    • updated
 
user
  • event
    • created
    • updated
    • deleted
 
group
  • event
    • created
    • updated
    • deleted
    • userAdded
    • userRemoved
    • groupAdded
    • groupRemoved
 

Properties

NameData typeData formatDescription
resourceTypestringThe type of resource events to subscribe to. See 'Remarks' section for available values.
eventstringThe type of event to subscribe to. See 'Remarks' section for available values.
contentTypeIdstringSubscribe to events for a specific content type. Used when subscribing to events for a resource type whose instances have a contentTypeId property.
idstringuuidSubscribe to events for a specific instance. Used when subscribing to events for a resource type whose instances have an id property.
dataFormatstringSubscribe to events for a specific data format. Used when subscribing to events for a resource type whose instances have a dataFormat property.
workflowStateChangedstringSubscribe to events where the workflow state changed. Used when subscribing to events for a resource type whose instances go through a workflow.
workflowEventRaisedstringSubscribe to events where a work flow event has been raised. Used when subscribing to events for a resource type whose instances go through a workflow.

Example

An example of Topics used in an webhook subscription

{
    "id": "3a7ce8e3-9c9f-4242-be20-35edb29c4a07",
    "name": "Content sync",
    "invokeUrl": "https://external.mywebsite.com/handlewebhooks",
    "enabled": true,
    "topics": [
        {
            "resourceType": "entry",
            "event": "updated",
            "language": "fr-fr",
            "contentTypeId": "blog",
            "owner": "t.durden"
        },
        {
            "resourceType": "entry",
            "event": "published",
            "contentTypeId": "news",
            "owner": "t.durden"
        },
        {
            "resourceType": "contentType",
            "event": "created"
        }
    ]
}
Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.