Go to website
Documentation for techies. How to use our REST & JS APIs, how to tweak the chatbox, etc.
How to open the chatbox on click on a custom button?
How can I automatically set user emails?
How to use Crisp API?
Crisp exposes a REST API which is documented on: https://docs.crisp.chat/api/ Here are our libraries for easy integration: Go: https://github.com/crisp-im/go-crisp-api NodeJS: https://github.com/crisp-im/node-crisp-api PHP: https://github.com/crisp-im/php-crisp-api
How to hide and show the chatbox?
How is security managed on Crisp services?
Crisp takes your security and the security of your website visitors very seriously. Our team implemented security best-practices at every level. Ubiquitous Encryption Encryption has become so cheap and convenient today that it's now possible to enable it everywhere. All public network channels on the Crisp platform are fully encrypted. This comes for both assets loading (
How to hide the chatbox on some pages?
Crisp allows you to hide the chatbox on some pages. You can block the chatbox on some pages Here's how to proceed: Go to your website settings: click on the "Settings" icon on the left sidebar, then click on "Websites" and select the target website in the list Select Chatbox & Email settings Go to chatbox restrictions Click on "Add a blocked page" Your chatbox
How to restore chat sessions with a token?
If your website shows the chatbox for authenticated users only - in other words: users for which you have an internal identification value, such as an user ID, an email or a token - you may want to ensure that the Crisp chat session associated to that user stays the same, whatever the device he is on and whether your user clears his cookies or not. This ensures you get chats from the same user in the same Crisp session. You can do so using Crisp Tokens. A token is a private and secure a
How to adjust my CSP policy for Crisp?
In case you are using a CSP policy (Content Security Policy) on your website, the Crisp chatbox will not work out of the box. You will need to add Crisp domains to your Content Security Policy rules. Loose CSP Policy This is the policy we recommend, as it will allow you to support any future Crisp domain update. You can find below the wildcard domain ranges Crisp uses: JS, CSS, fonts, images, frames: https://*.crisp.chat WebSocket: wss://*.crisp.chat Strict CSP Pol
How to set the chatbox language dynamically?
How to use Web Hooks?
Web Hooks can be used by developers as a simple way to get a Web Service notified of real-time events occuring on a Crisp website. For instance, you may want to get your backend notified of messages sent by your website visitors, in real-time. This guide explains how Web Hooks work, and how to setup them. Web Hooks are available to all Crisp users, whether free or paid. What do Web Hooks do? Web Hooks can be used to integrate with Crisp, and receive real-time events from Crisp on a cust
How to use Crisp HTTP REST API?
Crisp provides a HTTP REST API for developers to easily develop custom behaviors for their Crisp website (eg. messaging, CRM). This article explains how to start using the Crisp HTTP REST API. The Crisp API is documented on https://docs.crisp.chat/api/v1/. You will need to check this documentation if you start integrating your backend or app with Crisp. The Crisp HTTP REST API endpoint is: https://api.crisp.chat/v1 Crisp provides libraries for comm
Can I use Cloudflare with Helpdesk?
Cloudflare is a CDN provider that is used by websites to speed up their website. Their visitors get a faster browsing experience, and the website gets improved security. If you are already using Cloudflare to host the DNS of your domain (eg. acme.com), on which your Crisp Helpdesk is running (eg. help.acme.com), then Cloudflare lets you enable "proxy mode" on your Crisp Helpdesk domain. This is not required but can help improve performance. 1. Enable proxy mode **Enabling the Cloudfla
How to push user event from my backend?
Crisp lets you push events from the Crisp chatbox. If, however, you'd like to push those events from your backend instead, there's a way to do it via the Crisp REST API. This article explains how to do so. First of all, you need to connect your backend to the Crisp APIs. Read this introduction article on how to do it. Once you are done, you will follow this integration process (expla
How to send messages from my backend?
Most Crisp users interact with you from the chatbox, email or integrations. You may want to develop bots or automation systems, for which messages get sent from your own backend. First of all, you need to connect your backend to the Crisp APIs. Read this introduction article on how to do it. Once you are done, you will follow this integration process (explained in details below): Your backend can reach the Crisp REST API for sen
How to automatically set my user's phone number