Connectors / Service / Algolia

Enterprise grade search as a service (updated: 1633093264606)

Algolia

A Search-as-a-Service platform that enables companies of all sizes to deliver fast and relevant digital experiences that drive real results

Overview

Algolia is a Search-as-a-Service platform that enables companies of all sizes to deliver fast and relevant digital experiences that drive real results

Authentication

To authenticate with Algolia, add an Algolia step to your workflow. Once added to your workflow, click on the new authentication button found on the input panel. This will open the Algolia authentication dialog:

algolia-auth-dialog

You can retrieve your App ID and Admin API key by going to 'API Keys' in your Algolia dashboard:

algolia-api-keys

Notes on using the Algolia connector

When using the Search Facet Values operation, you will need to make sure that you have at least one attribute set for faceting, and made searchable:

facet-values-searchable

The properties for the operation can then be set:

facet-values-operation-props

This will return a list of objects which match the query, and highlights the facet query:

facet-query-result

When updating objects, using either Batch Write Operations or Create / Update Object with ID, you will need to specify the objectID:

algolia-batch-write-operations

Note that if you use 'Update object' it will re-create the object with only the attributes you specify.

'Partial update object' however, will update the attributes you specify, and maintain the other attrbutes already present in the object.

Example usage

The following workflow shows a very simple example of pulling details about a new / updated Salesforce opportunity and sending them to an Algolia search index:

sf-to-algolia-workflow

The steps involved here are:

  1. The workflow is triggered by a new/updated Salesforce opportunity

  2. Get opportunity uses the $.steps.trigger.events[0].Id jsonpath to pull the Opportunity ID from the trigger and extract all the required fields

  3. Loop collection loops through the opportunities (in this case it will be a list of 1 because we are searching by unique Opportunity ID!)

  4. Add object to index

algolia-create-object-in-index

Note that here we are using the Salesforce Opportunity ID as the Algolia objectID

And we are pulling in the fields returned by Salesforce to use directly as the attributes for the index

An example of the type of information which might be pulled in is:

{
"index": "opportunity",
"admin_api_key": "c2... <**--removed--**>",
"application_id": "0E... <**--removed--**>",
"object_id": "0065zxxxxxLB0AAO",
"object": {
"Id": "0065zxxxxxLB0AAO",
"Type": "Existing Customer",
"Amount": 1000,
"StageName": "Review Pending",
"IsWon": false,
"Description": null
}
}

All Operations

Latest version:

1.1

Add New Object

Add a new object to an index

Clear Index

Clear all objects from an index

Copy/Move Index

Copy of move an index

Create/Update Object With ID

Upsert object with a specific ID

Delete Index

Delete an index

Delete Object With ID

Delete an object with a specific ID from your index

Get Index Search Output (Private)

Get the output for a search index

Get Index Settings

Get the settings for an index

Get Object With ID

Get object with a specific ID

List Index Facets DDL

List Indices DDL

Partial Create/Update Object With ID

Create or update a partial object with a specific ID

Search Index

Search a specific index in your Algolia account

Search Facet Values

Search a specific indexes facet for values based on a query

Update Index Settings

Update the settings for an index

Batch Write Operations

Send a batch of operations to an index