Page Events

A number of events are emitted for content state updates and content changes for Pages. 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/

Page Created EventWebhook

An aem.sites.page.created event will be triggered when a Page 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.page.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 (PageCreatedEventData) 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.page.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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
}
}
}

Page Modified EventWebhook

An aem.sites.page.modified event will be triggered when a Page 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.page.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 (PageModifiedEventData) 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.page.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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
},
"properties": [{"name": "string",
"changeType": "added"
}
]
}
}

Page Deleted EventWebhook

An aem.sites.page.deleted event will be triggered when a Page 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.page.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 (PageDeletedEventData) 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.page.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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
}
}
}

Page Moved EventWebhook

An aem.sites.page.moved event will be triggered when a Page is moved 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.page.moved"
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 (PageMovedEventData) 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.page.moved",
"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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
},
"oldPath": "string"
}
}

Page Published EventWebhook

An aem.sites.page.published event will be triggered when a Page 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.page.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 (PagePublishedEventData) 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.page.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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
},
"tier": "publish"
}
}

Page Unpublished EventWebhook

An aem.sites.page.unpublished event will be triggered when a Page 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.page.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 (PageUnpublishedEventData) 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.page.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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
},
"tier": "publish"
}
}

Page Versioned EventWebhook

An aem.sites.page.versioned event will be triggered when a Page version 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.page.versioned"
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 (PageVersionedEventData) 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.page.versioned",
"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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
},
"version": "string"
}
}

Page Restored EventWebhook

An aem.sites.page.restored event will be triggered when a Page is restored on the server from a 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.page.restored"
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 (PageRestoredEventData) 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.page.restored",
"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": "string",
"sourceUrl": "http://example.com",
"template": {"id": "string"
},
"version": "string"
}
}