Model Events

A number of events are emitted for content state updates and content changes for Content Fragments Models. For more details about how these events can be handled, please head over to the Adobe I/O Events Documentation linked below.

https://developer.adobe.com/events/docs/guides/

Content Fragment Model Created EventWebhook

An aem.sites.contentFragmentModel.created event will be triggered when a new Content Fragment Model is created on the server.

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
source required	string <uri> non-empty ^acct:aem(-cmstg)?-p\d+-e\d+@adobe\.com$ An instance of the acct URI scheme that uniquely identifies the producer of this event, of the format `acct:aem-p<programId>-e<environmentId>@adobe.com`.
specversion required	string >= 3 characters The version of the CloudEvents specification which the event uses. AEM events use the CloudEvents spec version 1.0.2, hence this value will be 1.0. Value: "1.0"
type required	string >= 4 characters ^aem\.*$ The type for the event. This will identify the AEM solution that has dispatched the event and may also include the type of entity and the activity that occurred. Value: "aem.sites.contentFragmentModel.created"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
dataschema	string <uri> An optional attribute, which may point to a JSON schema document that covers the data object.
time required	string <date-time> non-empty A timestamp of when the event occurred.
required	object (ContentFragmentModelCreatedEventData) The event payload.

Responses

200

Return a 200 status to indicate that the data was received successfully

Request samples

Payload

application/json

{"specversion": 1,
"type": "aem.sites.contentFragmentModel.created",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "7c1104e5-4cd7-47d6-a50f-2568c480f2e9",
"time": "2018-04-05T17:31:00Z",
"datacontenttype": "application/json",
"data": {"user": {"imsUserId": "string",
"principalId": "string",
"displayName": "string"
},
"path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
"sourceUrl": "http://example.com",
"id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
"tags": ["string"
]
}
}

Content Fragment Model Deleted EventWebhook

An aem.sites.contentFragmentModel.deleted event will be triggered when a Content Fragment Model is deleted on the server.

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
source required	string <uri> non-empty ^acct:aem(-cmstg)?-p\d+-e\d+@adobe\.com$ An instance of the acct URI scheme that uniquely identifies the producer of this event, of the format `acct:aem-p<programId>-e<environmentId>@adobe.com`.
specversion required	string >= 3 characters The version of the CloudEvents specification which the event uses. AEM events use the CloudEvents spec version 1.0.2, hence this value will be 1.0. Value: "1.0"
type required	string >= 4 characters ^aem\.*$ The type for the event. This will identify the AEM solution that has dispatched the event and may also include the type of entity and the activity that occurred. Value: "aem.sites.contentFragmentModel.deleted"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
dataschema	string <uri> An optional attribute, which may point to a JSON schema document that covers the data object.
time required	string <date-time> non-empty A timestamp of when the event occurred.
required	object (ContentFragmentModelDeletedEventData) The event payload.

Responses

200

Return a 200 status to indicate that the data was received successfully

Request samples

Payload

application/json

{"specversion": 1,
"type": "aem.sites.contentFragmentModel.deleted",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "7c1104e5-4cd7-47d6-a50f-2568c480f2e9",
"time": "2018-04-05T17:31:00Z",
"datacontenttype": "application/json",
"data": {"user": {"imsUserId": "string",
"principalId": "string",
"displayName": "string"
},
"path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
"sourceUrl": "http://example.com",
"id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
"tags": ["string"
]
}
}

Content Fragment Model Published EventWebhook

An aem.sites.contentFragmentModel.published event will be triggered when a Content Fragment is replicated to the publish tier.

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
source required	string <uri> non-empty ^acct:aem(-cmstg)?-p\d+-e\d+@adobe\.com$ An instance of the acct URI scheme that uniquely identifies the producer of this event, of the format `acct:aem-p<programId>-e<environmentId>@adobe.com`.
specversion required	string >= 3 characters The version of the CloudEvents specification which the event uses. AEM events use the CloudEvents spec version 1.0.2, hence this value will be 1.0. Value: "1.0"
type required	string >= 4 characters ^aem\.*$ The type for the event. This will identify the AEM solution that has dispatched the event and may also include the type of entity and the activity that occurred. Value: "aem.sites.contentFragmentModel.published"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
dataschema	string <uri> An optional attribute, which may point to a JSON schema document that covers the data object.
time required	string <date-time> non-empty A timestamp of when the event occurred.
required	object (ContentFragmentModelPublishedEventData) The event payload.

Responses

200

Return a 200 status to indicate that the data was received successfully

Request samples

Payload

application/json

{"specversion": 1,
"type": "aem.sites.contentFragmentModel.published",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "7c1104e5-4cd7-47d6-a50f-2568c480f2e9",
"time": "2018-04-05T17:31:00Z",
"datacontenttype": "application/json",
"data": {"user": {"imsUserId": "string",
"principalId": "string",
"displayName": "string"
},
"path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
"sourceUrl": "http://example.com",
"id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
"tags": ["string"
],
"tier": "publish"
}
}

Content Fragment Model Unpublished EventWebhook

An aem.sites.contentFragmentModel.unpublished event will be triggered when a Content Fragment Model is removed from the publish tier.

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
source required	string <uri> non-empty ^acct:aem(-cmstg)?-p\d+-e\d+@adobe\.com$ An instance of the acct URI scheme that uniquely identifies the producer of this event, of the format `acct:aem-p<programId>-e<environmentId>@adobe.com`.
specversion required	string >= 3 characters The version of the CloudEvents specification which the event uses. AEM events use the CloudEvents spec version 1.0.2, hence this value will be 1.0. Value: "1.0"
type required	string >= 4 characters ^aem\.*$ The type for the event. This will identify the AEM solution that has dispatched the event and may also include the type of entity and the activity that occurred. Value: "aem.sites.contentFragmentModel.unpublished"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
dataschema	string <uri> An optional attribute, which may point to a JSON schema document that covers the data object.
time required	string <date-time> non-empty A timestamp of when the event occurred.
required	object (ContentFragmentModelUnpublishedEventData) The event payload.

Responses

200

Return a 200 status to indicate that the data was received successfully

Request samples

Payload

application/json

{"specversion": 1,
"type": "aem.sites.contentFragmentModel.unpublished",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "7c1104e5-4cd7-47d6-a50f-2568c480f2e9",
"time": "2018-04-05T17:31:00Z",
"datacontenttype": "application/json",
"data": {"user": {"imsUserId": "string",
"principalId": "string",
"displayName": "string"
},
"path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
"sourceUrl": "http://example.com",
"id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
"tags": ["string"
],
"tier": "publish"
}
}

Content Fragment Model Modified EventWebhook

An aem.sites.contentFragmentModel.modified event will be triggered when a Content Fragment Model is modified on the server.

Request

Request Body schema: application/json

id required	string non-empty An identifier for the event. When used in combination with the `source` property, it allows for each instance of an event to be uniquely identified. That is to say, the combination of the `source` + `id` properties will be unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it may have the same id and should be treated as a duplicate.
source required	string <uri> non-empty ^acct:aem(-cmstg)?-p\d+-e\d+@adobe\.com$ An instance of the acct URI scheme that uniquely identifies the producer of this event, of the format `acct:aem-p<programId>-e<environmentId>@adobe.com`.
specversion required	string >= 3 characters The version of the CloudEvents specification which the event uses. AEM events use the CloudEvents spec version 1.0.2, hence this value will be 1.0. Value: "1.0"
type required	string >= 4 characters ^aem\.*$ The type for the event. This will identify the AEM solution that has dispatched the event and may also include the type of entity and the activity that occurred. Value: "aem.sites.contentFragmentModel.modified"
datacontenttype required	string non-empty The format of the data in the event. This will always be `application/json` for AEM events. Value: "application/json"
dataschema	string <uri> An optional attribute, which may point to a JSON schema document that covers the data object.
time required	string <date-time> non-empty A timestamp of when the event occurred.
required	object (ContentFragmentModelModifiedEventData) The event payload.

Responses

200

Return a 200 status to indicate that the data was received successfully

Request samples

Payload

application/json

{"specversion": 1,
"type": "aem.sites.contentFragmentModel.modified",
"source": "acct:aem-p56789-e12345@adobe.com",
"id": "7c1104e5-4cd7-47d6-a50f-2568c480f2e9",
"time": "2018-04-05T17:31:00Z",
"datacontenttype": "application/json",
"data": {"user": {"imsUserId": "string",
"principalId": "string",
"displayName": "string"
},
"path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
"sourceUrl": "http://example.com",
"id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
"tags": ["string"
],
"properties": [{"name": "string",
"changeType": "added"
}
]
}
}

➔ Next to Page Events