Algolia

The Algolia Connector helps you to create search index entries in your Algolia account.

Set Up Algolia

Perform the following steps to set up the Algolia action connector:

1. Click Configure Action Step from the left navigation panel.
2. Click Action Step to configure third-party services.
3. Within the Configure Action Step, click the Algolia connector.
   
   
4. Under Choose an Action tab, you will see three actions: Index Entries, Delete Entries, and Update Entries. 
   Action 1: Select the Index Entries action:
   
   
   1. Click the + Add New Account button to set up your Algolia account (see screenshot in next step).
      
      
      
   2. In the Authorize modal, enter a Title, an Application ID, and an API Key.
   To find your Application ID and API Key, log in to the Algolia dashboard and perform the following steps:
   
   1. Click Settings.
   2. Under Team and Access, you will find the required credentials.
      
   

   Additional Resource: For more details, refer to the Importing with API’s document.

   Then, click Authorize.
   
   3. On the Index Entries Configure Action page, you need to enter the Index Name and Entries data.
      1. Select the Index Name where you want to send the data in the form of a list of objects.
      2. In the Entries field, enter the data to be included in the index.
         
         

         Note: Provide your index data as per your object schema and in JSON format only.

   4. Click Proceed.
   5. You will see the input values which you have configured in the Configure Action modal.
      
   6. Check if the details are correct. If yes, click Test Action.
      
   7. Once set, click Save and Exit.
      
      
   8. Go to the Algolia Index section and check the latest index entry with the data we passed as objects within the connector configurations.
   
Action 2: Select the Delete Entries action:




1. Click the + Add New Account button to set up your Algolia account (see screenshot in next step).
   
2. In the Authorize modal, enter a Title, an Application ID, and an API Key.
   To find your Application ID and API Key, log in to the Algolia dashboard and perform the following steps:
   1. Click Settings.
   2. Under Team and Access, you will find the required credentials.
      
      

      Additional Resource: For more details, refer to the Importing with API’s document.

      Then, click Authorize.
      
3. On the Delete Entries Configure Action page, you need to enter the Index Name and Entries details.
   1. Select the Index Name.
   2. Enter the object ID to be deleted in the Entries field.
      
      

      Note: You can add multiple object IDs separated by a comma to delete from the Algolia index.

4. Click Proceed.
5. You will see the input values which you have configured in the Configure Action modal.
   
6. Check if the details are correct. If yes, click Test Action.
   
7. Once set, click Save and Exit.
   
   


Action 3: Select the Update Entries action:




1. Click the + Add New Account button to set up your Algolia account (see screenshot in next step).
   
   
2. In the Authorize modal, enter a Title, an Application ID, and an API Key.
   To find your Application ID and API Key, log in to the Algolia dashboard and perform the following steps.
   1. Click Settings.
   2. Under Team and Access, you will find the required credentials.
      
      

      Additional Resource: For more details, refer to the Importing with API’s document.

      Then, click Authorize.
      
3. On the Update Entries Configure Action page, you need to enter the Index Name and Entries data.
   1. Select the Index Name where you want to send the data in the form of a list of objects.
   2. In the Entries field, enter the data to be updated.
      
      

      Note: Provide your index data as per your object schema and in JSON format only.

4. Click Proceed.
5. You will see the input values which you have configured in the Configure Action modal.
   
   
6. Check if the details are correct. If yes, click Test Action.
   
   
7. Once set, click Save and Exit.
   
   
8. To verify the output, go to the Algolia Index section and check the updated entry.
   

This sets the Algolia action connector.