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 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. Security Practices In Our Team Our whole team implements strict security practices regarding how they access their accounts: Crisp always refused to sell any data and our policy is to respect your data privacy. Our busines
How to hide and show the chatbox?
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 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 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. Our Chat 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.ch
How to set the chatbox language dynamically?
How to verify user identity with cryptographic 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 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 send events from Crisp to Google Analytics via GTM?
This article explains how you can send Crisp's users events to Google Analytics using Google Tag Manager (or not). We will cover a few examples but regarding Google Analytics developpers docs you will be able to set a wide variety of use case. Depending on the way you use Crisp, you should be able to build users events for support, marketing & sales teams. If you want to have a look at all the events that are built in Crisp, you
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
Crisp chatbox Cookie & IP policy
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 change Crisp chatbox cookie expire date?
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). Inbound IPs
How to automatically set my user's phone number
How to set Google Ads (Adwords) data on Crisp users profile?
This article explains how you can send Google Adwords data to Crisp users' profile. We will cover an example but regarding Google adwords developpers docs you will be able to set a wide variety of use case. Depending on the way you use Crisp, you should be able to build users events for marketing & sales teams. If you want to have a look at all the events that are built in Crisp, you should have a look here(htt
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
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
How to prevent elements from being tracked by MagicBrowse?
MagicBrowse is built with privacy in mind and inputs are automatically hidden. You want to hide some elements to be tracked? here is how to do this Edit your HTML Page We build a data-browsing-ignore you can add to prevent an elements from being tracked by MagicBrowse. Example : Then you can implement the data-browsing-ignore attribute
How to reset a Crisp session when a user logs out?
How to track the UTM source
This article covers how to track UTM data and submit it to your Crisp customer's profile. As explained on Wikipedia, UTM Parameters are five variants of URL parameters used by marketers to track the effectiveness of online marketing campaigns across traffic sources and publishing media. Here is an example: https://www.example.com/page?utm_content=buffercf3b2&utm_medium=social&utm_source=facebook.com&utm_campaign=buffer In this case it could b
What is Crisp compliance with SOC2?
Information security is a reason for concern for all organizations, including those that outsource key business operation to third-party vendors (e.g., SaaS, cloud-computing providers). Rightfully so, since mishandled data—especially by application and network security providers—can leave companies vulnerable to attacks, such as data theft, extortion and malware installation. At Crisp we consider security very seriously, everything has been detailed over this article(/en/article/how-is-securi
Is the Magic Browse feature GDPR compliant?
Magic Browse is an innovative feature we offer. You can help your customer and lead them through your website directly and easily. This feature is available on the Unlimited Plan. How is it Working? We simply render the HTML and CSS contained on the DOM in an iframe to display it in Crisp (using the WebSockets) Is that allowed? First of all, you have to note that the cookies stored in Crisp are technical cookies. We don’t use third-party cookies (tracking cookies). The co