Typesense Cloud

The Typesense Cloud Connector lets you automate adding, updating, or deleting indexed documents in a Typesense Cloud collection. By integrating this connector in your Contentstack Automations, you can keep your search indexes in sync with your content workflows.

• Typesense Cloud account
• Contentstack account
• Access to organization that has Automate enabled

To use the Typesense Cloud connector, you must first add your Typesense Cloud account. To do so, follow the steps given below:

1. Click Configure Action Step in the left navigation panel.
2. Click Action Step to configure third-party services.
3. Within the Configure Action Step, click the Typesense Cloud connector.
4. Under Choose an Action tab, select any one action from the list. Here, we are selecting the Index an Entry action.
5. On the Configure Action page, click the + Add New Account to add your Typesense Cloud account.
6. In the Authorize modal, enter the API Key and the Typesense Host Node URL.
   1. To generate the API Key, login to your Typesense Cloud account.
   2. In the Typesense Cloud dashboard, click Overview in the left navigation panel.
   3. Click Generate API Keys to create a new API Key. An API key file is downloaded to your local machine. You will see two API keys: Admin API Key and Search Only API Key.
      • Search Only API Key: Use this API Key to search or read the data from Typesense Cloud collection.
      • Admin API Key: Use this API Key to write the data in the Typesense Cloud collection.
      
   4. Copy the Admin API Key.
   5. Copy the node URL to add the Typesense Host Node URL.
   6. To add/update/delete a document, you must create a Collection in the Typesense Cloud account. To do so, follow these steps:
      1. In the left navigation panel, click Collections.
      2. Click New Collection.
      3. Edit the example schema and click Create Collection.

      Additional Resource: Refer to the Collections documentation to learn more.

7. Enter an Account Name, then click Authorize.

Once done, you can go ahead and set up your Typesense Cloud connector.

Perform the following steps to set up the Typesense Cloud connector:

1. From the left navigation panel, click Configure Action Step.
2. Then, click Action Step to configure third-party services.
3. Within the Configure Action Step, click the Typesense Cloud connector.
4. Under Choose an Action, you will see these actions: Index an Entry, Update an Entry, and Delete an Entry.

Let’s look at each of them in detail.

This action adds a new document into a Typesense Cloud collection.

1. Under Choose an Action tab, select the Index an Entry action.
2. On the Index an Entry Configure Action page, enter the details given below:
   1. Click + Add New Account to connect your Typesense Cloud account as shown in the Connect your Typesense Cloud Account to Automate step.
   2. Select an existing Collection Name to add the document from the Lookup list.
   3. In the Document ID field, enter the ID of the document to add into the Typesense collection.

      Note: The Document ID in Typesense Cloud refers to the unique identifier for each record within a collection. This ID is essential for creating, updating, deleting, or retrieving records.

   4. In the Entry Data field, enter the entry data in JSON format to add in a specific collection.
      
3. Click Proceed.
4. Check if the details are correct. If yes, click Test Action.
5. The output will be shown as below. Click the Save and Exit button.
   

This action updates the entry data in the Typesense Cloud collection.

1. Under Choose an Action tab, select the Update an Entry action.
2. On the Update an Entry Configure Action page, enter the details given below:
   1. Click + Add New Account to connect your Typesense Cloud account as shown in the Connect your Typesense Cloud Account to Automate step.
   2. Select an existing Collection Name to update the document from the Lookup list.
   3. In the Document ID field, enter the ID of the document to update into the Typesense collection.
   4. In the Entry Data field, enter the entry data in JSON format to update a specific collection. It is not necessary to provide the complete document object; you only need to include the fields that require updating.
3. Click Proceed.
4. Check if the details are correct. If yes, click Test Action.
5. Once set, click Save and Exit.

This action removes a single document from the Typesense Cloud collection.

1. Under Choose an Action tab, select the Delete an Entry action.
2. On the Delete an Entry Configure Action page, enter the details given below:
   1. Click + Add New Account to connect your Typesense Cloud account as shown in the Connect your Typesense Cloud Account to Automate step.
   2. Select the Collection Name from the Lookup list where the document resides.
   3. In the Document ID field, enter the ID of the document to delete from the Typesense collection.
      
3. Click Proceed.
4. Check if the details are correct. If yes, click Test Action.
5. Once set, click Save and Exit.

This sets the Typesense Cloud connector.