Adobe Experience Manager Connector

Read content fragments, assets, and published pages from Adobe Experience Manager as a Cloud Service, and detect content changes.

Connections

OAuth 2.0

Authenticate to AEM as a Cloud Service as an Adobe user with an OAuth Web App credential from the Adobe Developer Console. Requests run with that user's AEM permissions.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
AEM Author Host	The host name of the AEM as a Cloud Service author environment, without https://. Shown in Cloud Manager as the author URL.
Client ID	The Client ID of the OAuth Web App credential in the Adobe Developer Console project. Also sent as the X-Api-Key header.
Client Secret	The Client Secret of the OAuth Web App credential in the Adobe Developer Console project.
Scopes	The comma separated scopes to request, exactly as the credential's Scopes tab in the Adobe Developer Console lists them. Adobe rejects the authorization when a scope the credential does not list is requested.	openid,AdobeID,aem.assets.author,aem.folders
Authorize URL	The Adobe IMS authorization endpoint. Change only when Adobe directs a different region.	https://ims-na1.adobelogin.com/ims/authorize/v2
Token URL	The Adobe IMS token endpoint. Change only when Adobe directs a different region.	https://ims-na1.adobelogin.com/ims/token/v3

OAuth 2.0 Client Credentials

Authenticate to AEM as a Cloud Service with an OAuth Server-to-Server credential from the Adobe Developer Console.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
AEM Author Host	The host name of the AEM as a Cloud Service author environment, without https://. Shown in Cloud Manager as the author URL.
Client ID	The Client ID of the OAuth Server-to-Server credential in the Adobe Developer Console project. Also sent as the X-Api-Key header.
Client Secret	The Client Secret of the OAuth Server-to-Server credential in the Adobe Developer Console project.
Scopes	The space or comma separated scopes listed on the OAuth Server-to-Server credential in the Adobe Developer Console. Copy them exactly as shown.
Token URL	The Adobe IMS token endpoint. Change only when Adobe directs a different region.	https://ims-na1.adobelogin.com/ims/token/v3

Triggers

AEM Assets Event Subscription

Receive and validate asset events from Adobe Experience Manager, including metadata updates that the New and Updated Assets trigger cannot detect. Handles URL verification challenges automatically, and automatically creates and manages an Adobe I/O Events webhook registration with the environment's AEM Assets event provider when the instance is deployed, removing it when the instance is deleted.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Consumer Organization ID	The Adobe Developer Console consumer organization ID that owns the project.
Project ID	The ID of the Adobe Developer Console project with AEM Events enabled.
Workspace ID	The ID of the Adobe Developer Console workspace within the project.
Event Provider ID	The ID of the environment's AEM Assets event provider. Adobe creates one AEM Sites provider and one AEM Assets provider per environment once AEM Events is enabled for it.
Event Types	The AEM Assets events to subscribe to.	["aem.assets.asset.processing_completed", "aem.assets.asset.metadata_updated", "aem.assets.asset.published", "aem.assets.asset.unpublished", "aem.assets.asset.deleted"]
Publish Base URL	The public base URL of the published site, used to build each record's URL from its path. Leave empty to omit URLs.

AEM Sites Event Subscription

Receive and validate content fragment and page events from Adobe Experience Manager. Handles URL verification challenges automatically, and automatically creates and manages an Adobe I/O Events webhook registration with the environment's AEM Sites event provider when the instance is deployed, removing it when the instance is deleted. With a Publish Base URL, page events carry the published page URL for Get Published Page HTML.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Consumer Organization ID	The Adobe Developer Console consumer organization ID that owns the project.
Project ID	The ID of the Adobe Developer Console project with AEM Events enabled.
Workspace ID	The ID of the Adobe Developer Console workspace within the project.
Event Provider ID	The ID of the environment's AEM Sites event provider. Adobe creates one AEM Sites provider and one AEM Assets provider per environment once AEM Events is enabled for it.
Event Types	The AEM Sites content fragment and page events to subscribe to.	["aem.sites.contentFragment.created", "aem.sites.contentFragment.modified", "aem.sites.contentFragment.published", "aem.sites.contentFragment.unpublished", "aem.sites.contentFragment.deleted", "aem.sites.page.created", "aem.sites.page.modified", "aem.sites.page.published", "aem.sites.page.unpublished", "aem.sites.page.deleted"]
Publish Base URL	The public base URL of the published site, used to build each record's URL from its path. Leave empty to omit URLs.

New and Updated Assets

Retrieves existing and ongoing assets from Adobe Experience Manager. Load history once, check for changes on a schedule, or both.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Look-back Date	The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each asset modified on or after this date once.
Folders	Only include assets inside one of these folder IDs, at any depth.	[]
MIME Types	Only include assets with one of these exact MIME types.	[]
Publish Base URL	The public base URL of the published site, used to build each record's URL from its path. Leave empty to omit URLs.

New and Updated Fragments

Retrieves existing and ongoing content fragments from Adobe Experience Manager. Load history once, check for changes on a schedule, or both.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Look-back Date	The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each content fragment modified on or after this date once.
Path	Only return content fragments under this folder path below /content/dam, such as wknd/en/adventures. A full repository path starting with /content/dam is also accepted.
Statuses	Only emit content fragments in one of these statuses. The default covers live content: Published, and Modified (published, then edited).	["PUBLISHED", "MODIFIED"]
Content Fragment Models	Only return content fragments based on one of these model IDs.	[]
Tags	Only return content fragments with at least one of these tag IDs.	[]
Locales	Only return content fragments in one of these locales.	[]
Publish Base URL	The public base URL of the published site, used to build each record's URL from its path. Leave empty to omit URLs.

Actions

Create Folders

Create one or more asset folders. Fails when no folder could be created; when only some fail, they are listed in failedFolders. A request that runs as a job returns a job ID; check it with Get Folder Job Status.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Folder Paths	The folder paths below /content/dam, such as wknd-shared/en/new-folder. A full repository path starting with /content/dam is also accepted.	[]

Delete Asset

Delete an asset. Usually completes immediately; when AEM runs the delete as a job, returns a job ID to check with Get Asset Job Status.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Asset ID	The ID of the asset, in urn:aaid:aem:... form.
Force	When true, deletes the asset even when it is referenced elsewhere.	false

Delete Folders

Delete one or more asset folders by path. Fails when no folder could be deleted; when only some fail, they are listed in failedFolders. A request that runs as a job returns a job ID; check it with Get Folder Job Status.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Folder Paths	The folder paths below /content/dam, such as wknd-shared/en/new-folder. A full repository path starting with /content/dam is also accepted.	[]
Recursive	When true, deletes each folder and everything inside it.	false
Force	When true, deletes even when assets in the folders are referenced elsewhere.	false

Download Asset

Download the original binary of an asset.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Asset ID	The ID of the asset, in urn:aaid:aem:... form.
File Name	The file name to request the binary under, usually the asset's own name.

Download Asset Rendition

Download a rendition of an asset, such as a web-optimized image or text version.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Asset ID	The ID of the asset, in urn:aaid:aem:... form.
Rendition Name	The name of the rendition, as returned by List Asset Renditions.
File Name	The file name to request the binary under, usually the asset's own name.

Get Asset Job Status

Retrieve the state of a Delete Asset job.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Job ID	The job ID returned by the action that started the job.

Get Asset Metadata

Retrieve the repository and asset metadata of an asset.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Asset ID	The ID of the asset, in urn:aaid:aem:... form.

Get Content Fragment

Retrieve a content fragment by ID.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Content Fragment ID	The unique identifier for the content fragment, a UUID as returned by List Content Fragments or Search Content Fragments.
Include Metadata	When true, includes each content fragment's metadata in the response.	false
References	Which referenced content to include. Leave empty to omit references.

Get Folder Job Status

Retrieve the state of a Create Folders or Delete Folders job.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Job ID	The job ID returned by the action that started the job.

Get Import Job Status

Retrieve the state and progress of an Import Asset from URL job.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Job ID	The job ID returned by the action that started the job.

Get Published Page HTML

Retrieve the published HTML of a page by URL. Accepts URLs from List Sitemap URLs or AEM Sites Event Subscription page events.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Sitemap URL	The https:// URL of the site's sitemap or sitemap index. Used only to populate the Page URL dropdown; this action does not send it.
Page URL	The https:// URL of the published page to fetch.

Import Asset from URL

Create an asset by having AEM download a file from a URL. Runs as a job; check it with Get Import Job Status.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Destination Folder Path	The path of the folder to import into, below /content/dam, such as wknd-shared/en. A full repository path starting with /content/dam is also accepted.
File URL	The https:// URL AEM downloads the file from. It must be reachable from AEM.
File Name	The name the asset is created with.
MIME Type	The file's MIME type. Leave empty to let AEM detect it.

List Asset Renditions

List the renditions available for an asset.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Asset ID	The ID of the asset, in urn:aaid:aem:... form.

List Assets in Folder Tree

List every asset in a folder and all of its subfolders.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Root Folder Path	The path of the folder to walk, below /content/dam, such as wknd-shared/en. Assets in every subfolder are included. A full repository path starting with /content/dam is also accepted.	/content/dam

List Content Fragment Models

List the content fragment models available in the environment.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination, up to 500 pages of 50. Limit is ignored; when Cursor is set, fetching starts from that page. When more results remain, the output includes a cursor to continue from.	false
Pagination	Cursor and page-size controls for paging through results.
Cursor	The cursor returned by a previous page, used to fetch the next page.
Limit	The maximum number of results to return per page, from 1 to 50.
Projection	How much of each content fragment to return. Leave empty for the API default.

List Content Fragments

List content fragments, optionally under a path.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination, up to 500 pages of 50. Limit is ignored; when Cursor is set, fetching starts from that page. When more results remain, the output includes a cursor to continue from.	false
Pagination	Cursor and page-size controls for paging through results.
Cursor	The cursor returned by a previous page, used to fetch the next page.
Limit	The maximum number of results to return per page, from 1 to 50.
Path	Only return content fragments under this folder path below /content/dam, such as wknd/en/adventures. A full repository path starting with /content/dam is also accepted.
Projection	How much of each content fragment to return. Leave empty for the API default.
Include Metadata	When true, includes each content fragment's metadata in the response.	false
References	Which referenced content to include. Leave empty to omit references.

List Content Fragment Variations

List the variations of a content fragment.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Content Fragment ID	The unique identifier for the content fragment, a UUID as returned by List Content Fragments or Search Content Fragments.
Fetch All	When true, automatically fetches all pages of results using pagination, up to 500 pages of 50. Limit is ignored; when Cursor is set, fetching starts from that page. When more results remain, the output includes a cursor to continue from.	false
Pagination	Cursor and page-size controls for paging through results.
Cursor	The cursor returned by a previous page, used to fetch the next page.
Limit	The maximum number of results to return per page, from 1 to 50.

List Folder Contents

List the folders and assets directly inside a folder.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Folder Path	The folder path below /content/dam, such as wknd-shared/en. A full repository path starting with /content/dam is also accepted.	/content/dam
Fetch All	When true, automatically fetches all pages of results using pagination, up to 500 pages of 50. Limit is ignored; when Cursor is set, fetching starts from that page. When more results remain, the output includes a cursor to continue from.	false
Pagination	Cursor and page-size controls for paging through results.
Cursor	The cursor returned by a previous page, used to fetch the next page.
Limit	The maximum number of results to return per page, from 1 to 50.
Item Types	Which kinds of items to list.	FOLDER,ASSET
Order By	The field to order items by. Leave empty for the API default order.

List Sitemap URLs

List page URLs and their last-modified dates from a site's sitemap, following a sitemap index. Pass the URLs to Get Published Page HTML.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Sitemap URL	The https:// URL of the site's sitemap or sitemap index. Child sitemaps on the same host are followed.
Modified After	Only return pages whose sitemap lastmod is after this ISO 8601 date-time. Pages without a lastmod are excluded when set.
Include Path Prefixes	Only return pages whose URL path starts with one of these prefixes.	[]
Exclude Path Prefixes	Leave out pages whose URL path starts with one of these prefixes.	[]

Raw Request

Send raw HTTP request to Adobe Experience Manager.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
URL	Input the path only (for example, /adobe/sites/cf/fragments). The AEM author host is already included.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.	[]
File Data	File Data to be sent as a multipart form upload.	[]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.	[]
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.	[]
Header	A list of headers to send with the request.	[]
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Search Assets

Search assets by folder, MIME type, modified date, and text.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination, up to 500 pages of 50. Limit is ignored; when Cursor is set, fetching starts from that page. When more results remain, the output includes a cursor to continue from.	false
Pagination	Cursor and page-size controls for paging through results.
Cursor	The cursor returned by a previous page, used to fetch the next page.
Limit	The maximum number of results to return per page, from 1 to 50.
Folders	Only include assets inside one of these folder IDs, at any depth.	[]
MIME Types	Only include assets with one of these exact MIME types.	[]
Modified After	Only return assets modified at or after this ISO 8601 date-time.
Modified Before	Only return assets modified before this ISO 8601 date-time.
Filters	Optional query controls to sort and refine the results.
Search Text	Full-text search across asset metadata. Leave empty to match every asset.
Sort By	The field to sort results by. Leave empty to sort by relevance.
Sort Order	The direction to sort results in. Used only when Sort By is set.	ASC

Search Content Fragments

Search content fragments by path, status, model, tag, locale, modified or published date, and text.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination, up to 500 pages of 50. Limit is ignored; when Cursor is set, fetching starts from that page. When more results remain, the output includes a cursor to continue from.	false
Pagination	Cursor and page-size controls for paging through results.
Cursor	The cursor returned by a previous page, used to fetch the next page.
Limit	The maximum number of results to return per page, from 1 to 50.
Path	Only return content fragments under this folder path below /content/dam, such as wknd/en/adventures. A full repository path starting with /content/dam is also accepted.
Only Direct Children	When true, only returns content fragments directly under Path, not in its subfolders.	false
Statuses	Only return content fragments in one of these statuses.	[]
Content Fragment Models	Only return content fragments based on one of these model IDs.	[]
Tags	Only return content fragments with at least one of these tag IDs.	[]
Locales	Only return content fragments in one of these locales.	[]
Date Range Filters	Optional date-range filters. Narrow results by when content fragments were last modified or published.
Modified After	Only return content fragments modified after this ISO 8601 date-time.
Modified Before	Only return content fragments modified before this ISO 8601 date-time.
Published After	Only return content fragments published after this ISO 8601 date-time.
Published Before	Only return content fragments published before this ISO 8601 date-time.
Filters	Optional query controls to sort and refine the results.
Full Text	Only return content fragments whose content matches this text.
Sort By	The field to sort results by. Leave empty for the API default order.
Sort Order	The direction to sort results in. Used only when Sort By is set.	ASC
Projection	How much of each content fragment to return. Leave empty for the API default.
Include Metadata	When true, includes each content fragment's metadata in the response.	false

Update Asset Metadata

Set or remove asset metadata fields, such as dc:title, on an asset.

Input	Comments	Default
Connection	The AEM as a Cloud Service connection to use.
Asset ID	The ID of the asset, in urn:aaid:aem:... form.
Metadata Values	Metadata fields to set, keyed by field name such as dc:title. Only asset metadata is writable; repository metadata is read-only.	[]
Fields to Remove	Metadata field names to remove from the asset, such as dc:description.	[]