On this page: Learn how administrators configure Browsing integrations that let marketers search, browse, and select items from external APIs directly in the authoring experience, and how to link them to Standard integrations.
In addition to Standard integrations, you can create Browsing integrations. A Browsing integration lets marketers search, browse, and paginate through items returned by an external API, then select a specific item directly in the authoring experience instead of manually entering a parameter value.
Create a Browsing integration create-browsing
As an administrator, you create a Browsing integration from the Browsing tab of the Integrations configuration, using the same step-by-step instructions as for Standard integrations.
Once the integration information is provided, configure the following Browsing-specific settings:
-
From the Items configuration menu, choose the Items path where the list of items is located.
-
In the Search configuration drop-down, Enable search and select which parameter carries the search query, then provide a description for marketers.
-
In the Pagination configuration menu, enable Pagination and choose a pagination type:
accordion Offset Configure the following fields to set up Offset pagination:
-
Total path: Provide the path to the total result count in the response body.
-
Offset parameter: Specify the request parameter that indicates the number of items to skip.
-
Limit parameter: Specify the request parameter that indicates the number of items to return.
-
Page size: Set the number of items to request per page.
accordion Page Configure the following fields to set up Page pagination:
-
Total path: Provide the path to the total result count in the response body.
-
Page parameter: Specify the request parameter that indicates the page number.
-
Page size parameter: Specify the request parameter that indicates the number of items per page.
-
Page size: Set the number of items to request per page.
-
First page is: Select whether the first page in the sequence is numbered 0 or 1.
-
Total pages path: Provide the path to the total page count in the response body. Optional if you’ve provided the total count path.
accordion Cursor Configure the following fields to set up Cursor pagination:
-
Total path: Provide the path to the total result count in the response body.
-
Cursor parameter: Specify the request parameter that carries the cursor value.
-
Limit parameter: Specify the request parameter that indicates the number of items to return.
-
Page size: Set the number of items to request per page.
-
Next cursor source: Select where the next cursor value is read from in the response.
-
Next cursor path: Provide the path to the next cursor value in the response body.
-
-
From the Render menu, choose how items are displayed to marketers:
accordion Table For each column, choose the Label and the Data path. Optionally, select Quick map to add several fields as columns at once.
You can reorder columns as needed, or select
accordion List Fill in the following details:
- Primary path: Provide the data key for the main label of each item.
- Secondary path: Specify the data key for the subtitle.
- Tag path: Specify the data key for the tag badge.
accordion Avatar Fill in the following details:
- Name path: Specify the data key for the display name shown below the avatar.
- Image path: Specify the data key for the avatar image URL.
- Description path: Provide the data key for the subtitle shown below the name.
-
Click Test browsing to preview the search and pagination behavior with the configured settings.
-
Save the Browsing integration, then click Publish and Activate.
Link a Browsing integration to a Standard integration use-Browsing
Once a Browsing integration is created, you can link it to a parameter on a Standard integration so marketers can select values through the Browsing selector instead of entering them manually.
-
While configuring a parameter on a Standard integration, enable Browsing.
-
Choose the Browsing integration to link.
-
Save and publish the Standard integration.
Select items during authoring select-Browsing-items
When a parameter is linked to a Browsing integration, marketers can pick its value from a selector in the message or journey editor, rather than typing it manually.
-
Access your campaign content and click Add personalization from your Text or HTML Components.
-
Navigate to the Integrations section and click Open integrations to view all active integrations.
-
Select an integration.
-
Search and browse the paginated list of items returned by the Browsing integration, then select an entity and confirm your selection.
The corresponding Reference path value is then automatically inserted into the integration parameter.
-
Click Save.
See also
How-to video how-to
Watch the video below to learn how to configure a Browsing integration for an external API and link it to a Standard integration, so marketers can search, browse, and select items in the Adobe Journey Optimizer editor without manually entering values.
This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.
For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.
- TL;DR: Configure a Browsing integration and link it to a Standard integration parameter so marketers can search, browse, and select items returned by an external API during authoring.
Intents:
- Configure the items path, search query parameter, and pagination for a Browsing integration.
- Choose how items are displayed to marketers.
- Preview search and pagination behavior with Test browsing.
- Link a Browsing integration to a Standard integration parameter.
- Select an item during authoring and insert its Reference path value into the integration parameter.
Glossary:
- Browsing integration: An integration that lets marketers search, browse, and paginate through items returned by an external API, then select a specific item directly in the authoring experience. (product-specific)
- Items path: The path where the list of items is located. (product-specific)
- Offset parameter: The request parameter that indicates the number of items to skip. (product-specific)
- Page parameter: The request parameter that indicates the page number. (product-specific)
- Cursor parameter: The request parameter that carries the cursor value. (product-specific)
- Reference path: The value corresponding to the selected entity that is automatically inserted into the integration parameter. (product-specific)
- Test browsing: A preview of search and pagination behavior with the configured settings. (product-specific)
Guardrails:
- Browsing integrations are created by an administrator from the Browsing tab of the Integrations configuration.
- When a parameter is linked to a Browsing integration, marketers can pick its value from a selector in the message or journey editor, rather than typing it manually.
- In Page pagination, First page is selects whether the first page is numbered 0 or 1; Total pages path is optional if the total count path is provided.
Terminology:
- Canonical name: Browsing integration.
- Do not confuse: Offset parameter indicates the number of items to skip; Page parameter indicates the page number; Cursor parameter carries the cursor value.
- Do not confuse: Page size sets the number of items to request per page; Page size parameter specifies the request parameter that indicates the number of items per page in Page pagination.
FAQ:
- Q: Which pagination types can I choose? Offset, Page, or Cursor.
- Q: How can items be displayed to marketers? The Render menu provides Table, List, and Avatar.
- Q: What does Test browsing preview? Test browsing previews the search and pagination behavior with the configured settings.
- Q: How does a Browsing integration let marketers select a Standard integration parameter value? Link the Browsing integration to the parameter on the Standard integration so marketers can select values through the Browsing selector instead of entering them manually.
- Q: What value is inserted after an entity is selected and the selection is confirmed? The corresponding Reference path value is automatically inserted into the integration parameter.
Personas:
- marketer: Can search, browse, and select items from an external API during authoring, instead of entering values manually. Can select Add personalization, open integrations, select an integration, then search, browse, and select an entity to confirm. The page states that the corresponding Reference path value is then automatically inserted into the integration parameter. Where: “Select items during authoring”.
Onboarding:
- Level: Beginner
- First minimal step: Access your campaign content and select Add personalization from your Text or HTML Components.
- Success check: The corresponding Reference path value is then automatically inserted into the integration parameter.
- Previous: Link a Browsing integration to a parameter on a Standard integration: Create Standard integrations (integrations/integrations-create.md)
- Next: Learn more about the Text or HTML components used for personalization: Use Email Designer content components (email/content-components.md); Troubleshoot issues with Browsing or Standard integrations: Frequently asked questions about Integrations (integrations/vendor-integration-faq.md)