Links

Algolia Search

This page provides an overview of the Algolia Search connection, which enables you to initiate an Algolia search request from within your application.
This page outlines the following aspects of the Algolia Search connection:

Configuration requirements

This table outlines the required information to configure an Algolia Search connection:
Configuration field
Description
Connection Name
Name of your connection. This appears as a title for your connection tile in the Connect tab.
apiKey
Code used to identify and authenticate Algolia users.
appID
The ID of your Algolia application.
indexName
The name of the index you want to retrieve.

Available actions

The Algolia Search connection enables you to add a search action to the connection. This action enables you to use the Algolia API to retrieve information from within your application.
This table outlines the configurable parameters of Algolia Search's search action:
Parameter
Type
Description
query
string
The string you want Algolia to retrieve.
hitsPerPage
number
The number of hits per page you want returned.
page
number
The page you want to retrieve.
options
object
Customizable parameters that you can adjust in your Algolia dashboard.

Component preview

The component preview shows how your connection component appears in the Logic view of your Uiflow application.
This section outlines how to:

Change the component name

To change the component name, navigate to the Edit Action section and adjust the Action Name field.

Display parameters on the component

To display parameters on your connection component, click Expose above the parameter fields. Any selected parameters appear on the left of the connection component.