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 hide and show the 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 use Webhooks?
Webhooks can be used by developers as a simple way to get a Web Service notified of real-time events occurring 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 Webhooks do? Web Hooks can be used to integrate with Crisp, and receive real-time events from Crisp on a custo
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 set the chatbox language dynamically?
How to adjust my CSP policy for Crisp? (Content Security Policy)
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 You can find below the wildcard domain ranges Crisp uses: JS, CSS, fonts, settings, images, frames: https://*.crisp.chat WebSocket: wss://*.crisp.chat Also, ma
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
How to verify user identity with email signatures?
If you are running the Crisp Chatbox on a Web Dashboard where your users are authenticated to their accounts, you may want to see whether the email of the user chatting with you is verified or not. User verification lets you do that! This adds a bit of security to your support workflow. Required plan for User Verification The User Verification feature is available from Crisp Pro. You need to make sure your website is subscribed to that plan so that you can use the User Verification f
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 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 automatically set my user's phone number
Which IP addresses are used by Crisp?
Crisp uses a large outbound and inbound IP space. Some corporate offices or government agencies need to whitelist IP addresses their employees should be allowed to use. Here's a list that will help them whitelist Crisp (this only affects the operators using Crisp apps, not your actual website visitors).
How to change Crisp chatbox cookie expire date?
Which user agents are used by Crisp services? (useragent)
Crisp services may connect to your website and domains to fetch some data for chat purposes. For example, if you or a visitor sends a link to your website via the chat, Crisp services access your website to generate a preview for the link that was sent. In some cases, you may need to whitelist or serve a different version of your website for non-brower user agents. For instance, if you are using Distil Networks bot protection you may need to whitelist our user agents. User agents used by
Crisp chatbox Cookie & IP policy
How to restrict Crisp chatbox cookie to domain?
By default, Crisp shares its chatbox domain on your primary domain, and all its sub-domains. This lets you share the same chatbox session across all your website & apps. In some specific use cases, you may want to restrict the cookie to a given domain. You can do so using the Crisp Cookie Domain chatbox variable. The domain name is set as a string, and points to your base domain by default. For instance, if your website domain is www.acme.com, the base domain would be acme.com, and the