Skip to main content
Browse Documentation
HTTP - Management

Topic

Created by c.neale, last updated 08 Oct 2020

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
Created and deleted don't fit with
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.
ownerstringSubscribe to events for a specific content owner. Used when subscribing to events for a resource type whose instances have an owner 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.
workflowStatestringWhen subscribing to workflow state changes, restrict a subscription to events for a specific state. Used when subscribing to the workflowStateChanged events for a resource type whose instances go through a workflow.
workflowEventRaisedstringWhen subscribing to workflow events, restrict a subscription to specific workflow events. Used when subscribing to the workflowEventRaised 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"
        }
    ]
}