Format of the payload for event monitor webhooks
The payload can be in either TEXT, JSONTEXT, or JSON format.
- For a subset of the event information that is easy to read, use either:
- The TEXT format (content type: text/plain). See TEXT format.
- The JSONTEXT format (content type: application/json). See JSONTEXT format.
- For complete event information, use the JSON format (content type: application/json). (The event monitor supports only the first level of children.) See:
TEXT format
event timestamp
event action
attribute_name1=value1; attribute_name2=value2;...
ITEMTYPE=ItemTypeName;ITEMID=itemId;
CONTENTCHG=T|F (for update event if the library server is V8.7 fix pack 1 or later)
webhook info (if specified)
Example of TEXT format
2023-08-18-15.14.05.192000
CREATE
SOURCE=SourceRS;USER_ID=Rob
ITEMTYPE=NOINDEX;ITEMID=A1001001A20H18A81404H00000
JSONTEXT format
{"text":"event timestamp
event action
attribute_name1=value1; attribute_name2=value2;...
ITEMTYPE=ItemTypeName;ITEMID=itemId;
CONTENTCHG=T|F (for update event if the library server is V8.7 fix pack 1
or later)
webhook info (if specified)"}
Example of JSONTEXT format
{"text":"2023-08-18-15.14.05.192000
CREATE
SOURCE=SourceRS;USER_ID=Rob
ITEMTYPE=NOINDEX;ITEMID=A1001001A20H18A81404H00000"}
JSON format: CREATE
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_itemtype": <itemtype>,
"cmevent_pid": <pid>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}
Note: If the library server is at V8.7 fix pack 1 or
later, cmevent_content_change is returned for update.
Example of JSON format: CREATE
{
"cmrepository_name": "Content Manager",
"cmcomponent_name": "Content Manager Event Monitor",
"cmserver_name": "icmnlsdb",
"cmserver_version": "8.7.00.000",
"cmevent_timestamp": "2023-08-18-15.14.05.192000",
"cmevent_type": "ITEM",
"cmevent_action": "CREATE",
"cmevent_code": "301",
"cmevent_itemid": "A1001001A20H18A81404H00000",
"cmevent_itemtype": "MYNOINDEXEVENT",
"cmevent_pid": "94 3 ICM8 ICMNLSDB14 MYNOINDEXEVENT59 26 A1001001A20H18A81404H0000018 A20H18A81404H000001 14 1018",
"cmevent_number_comptypes": "1",
"cmevent_comptype_info": [
{
"cmevent_comptype_name": "MYNOINDEXEVENT",
"cmevent_number_comp": "1",
"cmevent_comp_info": [
{
"cmevent_comp_number_attrs": "3",
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": "SOURCE",
"cmevent_comp_attr_group": "",
"cmevent_comp_attr_len": "8",
"cmevent_comp_attr_type": "448",
"cmevent_comp_attr_value": "SHIPPING"
},
{
"cmevent_comp_attr_name": "USER_ID",
"cmevent_comp_attr_group": "",
"cmevent_comp_attr_len": "3",
"cmevent_comp_attr_type": "448",
"cmevent_comp_attr_value": "Kim"
},
{
"cmevent_comp_attr_name": "TIMESTAMP",
"cmevent_comp_attr_group": "",
"cmevent_comp_attr_len": "26",
"cmevent_comp_attr_type": "392",
"cmevent_comp_attr_value": "2023-08-17-08.30.30.123000"
}
]
}
]
}
],
"cmwebhook_info": ""
}
JSON format: UPDATE
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_itemtype": <itemtype>,
"cmevent_old_version": <old version>,
"cmevent_version": <version>,
"cmevent_pid": <pid>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>,
"cmevent_content_change":TRUE | FALSE
}
JSON format: DELETE
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_itemtype": <itemtype>,
"cmevent_version": <version>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}
JSON format: CHECKIN
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_itemtype": <itemtype>,
"cmevent_version": <version>,
"cmevent_pid": <pid>,
"cmevent_checkin_uid": <check-in userid>,
"cmevent_checkin_time": <check-in timestamp>,
"cmevent_checkout_uid": <checkout userid>,
"cmevent_checkout_time": <checkout timestamp>,
"cmevent_operation_type": <operation type>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}
JSON format: CHECKOUT
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_itemtype": <itemtype>,
"cmevent_version": <version>,
"cmevent_pid": <pid>,
"cmevent_checkout_uid": <checkout userid>,
"cmevent_checkout_time": <checkout timestamp>,
"cmevent_operation_type": <operation type>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}
JSON format: REINDEX
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_old_itemtype": <old itemtype>,
"cmevent_old_version": <old version>,
"cmevent_itemtype": <itemtype>,
"cmevent_version": <version>,
"cmevent_pid": <pid>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}
JSON format: REINDEXFROM
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_to_itemtype": <to itemtype>,
"cmevent_to_version": <to version>,
"cmevent_itemtype": <itemtype>,
"cmevent_version": <version>,
"cmevent_pid": <pid>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}
JSON format: ADD (FOLDER_ADD)
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_itemtype": <itemtype>,
"cmevent_version": <version>,
"cmevent_child_itemid": <child itemid>,
"cmevent_child_itemtype": <child itemtype>,
"cmevent_child_version": <child version>,
"cmevent_pid": <pid>,
"cmevent_child_pid": <child pid>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}
JSON format: REMOVE (FOLDER_REMOVE)
{
"cmrepository_name": <Content Repository Name>,
"cmcomponent_name": <Content manager Component name>,
"cmserver_name": <Content Manager Library Server Name where Event Monitor is running>,
"cmserver_version": <Content Manager Library Server Version>,
"cmevent_timestamp": <value>,
"cmevent_type": <event type>,
"cmevent_action": <event action>,
"cmevent_code": <event code>,
"cmevent_itemid": <itemid>,
"cmevent_itemtype": <itemtype>,
"cmevent_version": <version>,
"cmevent_child_itemid": <child itemid>,
"cmevent_child_itemtype": <child itemtype>,
"cmevent_child_version": <child version>,
"cmevent_pid": <pid>,
"cmevent_child_pid": <child pid>,
"cmevent_number_comptypes": <number of components types>,
"cmevent_comptype_info": [
{
"cmevent_comptype_name": <component type name>,
"cmevent_number_comp": <number of components>,
"cmevent_comp_info": [
{
"cmevent_number_comp_attrs": <number of component attributes>,
"cmevent_comp_attr_info": [
{
"cmevent_comp_attr_name": <component attribute name>,
"cmevent_comp_attr_group": <component attribute group>,
"cmevent_comp_attr_len": <component attribute length>,
"cmevent_comp_attr_type": <component attribute type>,
"cmevent_comp_attr_value": <component attribute value>
}
]
}
]
}
],
"cmwebhook_info": <webhook info>
}