Updated on September 21, 2021

In this guide you will learn how to create your first example Crisp plugin using the Marketplace.

We will use NodeJS to create the plugin, although note that the same process can be used with any programming language. After this tutorial, you will be able to create a full-featured plugin.

Video Tutorial

Create Your First Crisp Plugin

Example Plugin

1. Crisp Marketplace setup

Crisp Marketplace is the website that allows you to centralize all your integrations (also called plugins).
  1. Go to the Crisp Marketplace to create your account (note that this is different from your Crisp account)
  2. Create a plugin, either private or public

2. Configure the plugin


Make sure that your system has the following tools available:

  • NodeJS
  • NPM
  • Ngrok

Also, you need to be the owner of a website on Crisp, which will be used for development purposes.

Initial setup

  1. Kickstart your plugin by cloning the example repository from: crisp-im/crisp-plugin-node-example
  2. Install all dependencies with: npm install
  3. From the API tab of your plugin in the Marketplace, copy the token Identifier
  4. Paste the token Identifier in the cloned project code (in ./lib/pong_plugin.js: const crispAPIIdentifier = ...)
  5. Do the same for the token Key and plugin URN (you can find the plugin URN at the top of the page)
  6. Browse to the Settings tab of your plugin and add the content of the schema.json file (the file is available in the cloned repository)

3. Setup a tunnel between you and Crisp

  1. Download Ngrok and start ./ngrok http 1234 (where 1234 is the port specified in ./lib/index.js)
  2. Copy the URL provided by Ngrok (eg. https://a1e9e89c2d80.ngrok.io)
  3. Add the URL in the Settings URL field inside the Settings tab of your plugin
  4. Append /config.html to the URL and hit Save
Enter your Ngrok URL in the Settings URL field

4. Add a trusted website in the Marketplace

  1. Get your Website ID using this article: How to find the Website ID?
  2. Copy and paste the Website ID in the Trusted Website field of your Settings page in your Marketplace account
Add your Crisp Website ID as Trusted Website

5. Start the example plugin

  1. Start your app server using node ./lib/index.js
  2. Configure your plugin pong message: in the Settings tab of your plugin, send a test request and configure your message and hit Save
  3. Send a message in a Crisp conversation
  4. The plugin should respond with your custom message!