Algolia

The Algolia Connector helps you create, update, or delete search index entries in your Algolia account.

Set Up Algolia

The Algolia connector lets you perform the following actions:

1. Index Entries
2. Delete Entries
3. Update Entries

Let's first understand how you can use these actions to add/update/delete records in the Algolia index.

Index Entries

1. In the Configure Action section, select the Algolia connector.
   
   
   
2. Under Select an Action tab, select the Index Entries action.
   
   
3. Click the + Add New Account button to select your Algolia account.
   
4. In the Authorize modal, add a suitable Title, Application ID, and the API Key of your Algolia account to connect it with Contentstack.
   
   

To find your Application ID and API Key, login to Algolia dashboard and perform the following steps:

1. Click on 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.

5. Once done, click Authorize.
   
6. Select the Index Name where you want to send the data in the form of a list of objects.
   
7. 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

   
   
   
8. Click Proceed.
   
9. Click Test Action to test the configured action. 
   
10. After successful configuration, you should see the output shown below. Click Save and Exit.
    

Go to the Algolia Index section and check the latest index entry with the data we passed as objects within the connector configurations.

Delete Entries

1. Under Select an Action tab, select the Delete Entries action.
   
2. Click the + Add New Account button to select your Algolia account.
   
   
3. In the Authorize modal, add a suitable Title, Application ID, and the API Key of your Algolia account to connect it with Contentstack.
   
   

To find your Application ID and API Key, login to Algolia dashboard and perform the following steps:

1. Click on 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.

4. Once done, click Authorize.
   
   
5. Select the Index Name. 
   
6. 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.

   
7. Click Test Action to test the configured action. 
   
   
8. After successful configuration, you should see the output shown below. Click Save and Exit.
   
   

Update Entries

1. Under Select an Action tab, select the Update Entries action.
   
2. Click the + Add New Account button to select your Algolia account.
   
   
   
3. In the Authorize modal, add a suitable Title, Application ID, and the API Key of your Algolia account to connect it with Contentstack.
   
   

To find your Application ID and API Key, login to Algolia dashboard and perform the following steps:

1. Click on 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.

4. Once done, click Authorize.
   
   
   
5. Select the Index Name where you want to send the data in the form of a list of objects to update.
   
6. Enter the data to be updated in the Entries field.

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

   

7. Click Test Action to test the configured action.
    
   
   
8. After successful configuration, you should see the output shown below. Click Save and Exit.
   
   
   

This sets the Algolia action connector.