Connecting Algolia to Cosmic JS for Awesome Search Functionality

The use of Cosmic JS’s Webhooks, we will be able to sync Algolia with Cosmic JS to supply rapid and robust seek capability to our initiatives.



In case you’ve ever attempted to enforce seek your self, then you definately comprehend it may also be tough. Fortunately, Algolia has created a product that makes it simple. On this article we’re going to pass over how you’ll attach Algolia to your Cosmic JS backend and upload it to your Apps. The demo App was once constructed with React.js and an Specific.js server. In case you’re the usage of one thing other, you’ll nonetheless observe this trend. Simply adjust it for your use-case.

There are four primary steps:

  1. Create an Algolia App
  2. Create Cosmic JS Webhooks
  3. Create API endpoints to obtain the Cosmic JS Webhook POST requests
  4. Upload seek widgets to our App

Phase 1 — Create an Algolia App

Whenever you’ve logged in, navigate to the Dashboard.

Within the Dashboard, click on ‘NEW APPLICATION’.

Give your App a reputation and click on ‘CREATE’.

The following web page will ask you to select a area. Pick out the nearest one. Then click on ‘Proceed’.

You will have to now see the Dashboard for your newly created App. Click on ‘API Keys’ at the left facet of the display. This can be a listing of API Keys that you are going to want for later steps.

Phase 2 — Create Cosmic JS Webhooks

Log in to your Cosmic JS account and pass to your Bucket.

Make a choice ‘Settings’, then ‘Webhooks’ within the Dashboard menu.

You will have to attach three other Webhooks. Exchange the endpoints with no matter you’d like them to be for your undertaking

  1. Match: Object created and printed; Endpoint — 
  2. Object edited and printed; Endpoint — 
  3. Object deleted; Endpoint — 

Click on ‘Save Webhooks’. Now your server will obtain POST requests every time an Object is created, edited, or deleted. The next move is putting in your server to obtain the ones requests and use them to stay Algolia synced.

Phase 3 — Create API endpoints to obtain the Cosmic JS Webhook POST requests

The demo App makes use of a Node.js Specific server. Right here’s the code:

/* eslint-disable no-console */
const categorical = require('categorical');
const bodyParser = require('body-parser');
const corser = require('corser');
const subsequent = require('subsequent');
const routes = require('./routes');
const algoliasearch = require('algoliasearch');
const convertDataToAlgoliaObject = require('./utils/convertDataToAlgoliaObject');
const fetch = require('isomorphic-fetch'); const port = parseInt(procedure.env.PORT, 10) || 3000;
const dev = procedure.env.NODE_ENV !== 'manufacturing';
const app = subsequent();
const handler = routes.getRequestHandler(app); const shopper = algoliasearch( procedure.env.ALGOLIA_APPLICATION_ID, procedure.env.ALGOLIA_ADMIN_API_KEY,
const itemsIndex = shopper.initIndex('pieces'); app.get ready() .then(() => );
First, an algoliasearch shopper is created. It makes use of the Algolia Application ID and Admin API Key (which may also be discovered to your Algolia App Dashboard).

Then endpoints are created for every Webhook that we’d like to obtain from Cosmic JS. The Webhook POST requests come with the Object their it’s physique. A customized ‘convertDataToAlgoliaObject’ application serve as is used to convert that Cosmic JS Object into an object formatted for Algolia. Right here’s the code for ‘convertDataToAlgoliaObject’:

const convertDataToAlgoliaObject = (knowledge) => ; module.exports = convertDataToAlgoliaObject;

This serve as might be other for every undertaking. You principally simply need to extract the guidelines that might be ‘searchable’.

Now, Algolia’s algoliaseasrch library can be utilized to add, edit, or delete the corresponding access in Algolia.

The backend setup is entire! You will have to observe, then again, that no syncing will happen till you deploy your App. The customized API endpoints you created don’t exist but, so the Algolia Webhook POST requests gained’t be intercepted.

Phase 4 — Upload seek widgets to our App

No longer most effective does Algolia supply superior seek capability, additionally they supply many libraries that can be utilized to show your knowledge. I used their React Immediate Search library for the demo undertaking. It supplies React parts which can be necessarily plug-and-play. You’ll be able to customise their styling with your individual CSS. The documentation may be very well-written, so there’s little need to repeat it right here.


Expectantly, you discovered this text useful. If one thing isn’t transparent, take a look at the Cosmic JS or Algolia documentation. They’re each nice!

This text firstly seems on the Cosmic JS web page.