Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion apps/about-apps/components/external-product-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,16 @@ Never hardcode sensitive credentials in your configuration. Always store API key

After your External Product Catalog component is configured and the app is installed, it can be used within epilot's Journeys. Currently we support seamless integration of the external product catalog into the journey via Product Blocks and Product Recommendations Blocks (beta).

When a journey creator adds a **Product Block** or **Product Recommendations Block** in a journey, they can select the integration as the source for products. Only hooks that are supported for the selected block type will be available (e.g. only `products` hook for Product Block, only `productRecommendations` hook for Product Recommendations Block).
When a journey creator adds a **Product Block** or **Product Recommendations Block** in a journey, they can select the integration as the source for products. Only hooks that are supported for the selected block type will be available (e.g. only `products` hook for Product Block, only `products-recommendation` hook for Product Recommendations Block).

<img src="/img/apps/external-product-catalog/journey-product-block-config.png" width="500" />

This allows the journey to dynamically fetch products and pricing from your external catalog in journeys.

By default, only data from preceding steps (in their defined order) is passed to the steps/blocks data context. While this works for most use cases, you can configure the data context to also include data from subsequent steps, enabling non-linear journey flows. This configuration also makes the data each integration passes to the journey more explicit, lighter and easier to manage.

<img src="/img/apps/external-product-catalog/blocks-data-selection.png" width="500" />

## Usage in Portals

After your External Product Catalog component is configured and the app is installed, it can also be used within epilot's Portals.
Expand Down
10 changes: 7 additions & 3 deletions docs/apps/about-apps/components/external-product-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ They typically rely on your API for the execution of any necessary logic and exp
### Supported Hooks / Catalog Types

The interface supports two types of data exchange, depending on the block being used in the journey:
- **Products**: Returns an array of products.
- **Product Recommendations**: Returns a source product and a list of offer products.
- **Products**: Returns an array of products (`type: "products"`).
- **Product Recommendations**: Returns a source product and a list of offer products (`type: "products-recommendation"`).

### Template Variables

Expand Down Expand Up @@ -100,12 +100,16 @@ Never hardcode sensitive credentials in your configuration. Always store API key

After your External Product Catalog component is configured and the app is installed, it can be used within epilot's Journeys. Currently we support seamless integration of the external product catalog into the journey via Product Blocks and Product Recommendations Blocks (beta).

When a journey creator adds a **Product Block** or **Product Recommendations Block** in a journey, they can select the integration as the source for products. Only hooks that are supported for the selected block type will be available (e.g. only `products` hook for Product Block, only `productRecommendations` hook for Product Recommendations Block).
When a journey creator adds a **Product Block** or **Product Recommendations Block** in a journey, they can select the integration as the source for products. Only hooks that are supported for the selected block type will be available (e.g. only `products` hook for Product Block, only `products-recommendation` hook for Product Recommendations Block).

<img src="/img/apps/external-product-catalog/journey-product-block-config.png" width="500" />

This allows the journey to dynamically fetch products and pricing from your external catalog in journeys.

By default, only data from preceding steps (in their defined order) is passed to the steps/blocks data context. While this works for most use cases, you can configure the data context to also include data from subsequent steps, enabling non-linear journey flows. This configuration also makes the data each integration passes to the journey more explicit, lighter and easier to manage.

<img src="/img/apps/external-product-catalog/blocks-data-selection.png" width="500" />

## Usage in Portals

After your External Product Catalog component is configured and the app is installed, it can also be used within epilot's Portals.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading