Go to website
Documentation for techies. How to use our REST & JS APIs, how to tweak the chatbox, etc.
Perform automated actions with the chatbox
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 reset a Crisp session when a user logs out?
How to automatically set my user's phone number
How to use the $crisp chatbox SDK?
How to restore a chat session 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.
Integrate with Crisp from your backend
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 se
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 (expl
How to use the REST API?
The REST API is the backbone of Crisp. It is used by all Crisp apps to let operators send messages, access their CRM, and more. As an integration developer, you have access to almost all of the features Crisp apps enjoy.
How to use the RTM API?
The RTM API lets integrations receive real-time notifications of all events happening in Crisp websites it has access to. This can be used in pair with the REST API to eg. send a message through the REST API, and receive responses from the other party through the RTM API.
How to use Web Hooks?
Web Hooks are an easy and convenient way to receive events from a Crisp website. They can be configured in a few clicks, and do not require you to build an integration. Web Hooks are typically used for automation purposes, eg. automate a task with Zapier.
Install Crisp plugins on your website
How can I setup the Contact Form plugin?
The Contact Form plugin lets you create a contact form linked to your Crisp, which you can include on your website contact page. This guide goes through how to setup the Contact Form plugin on your website. It is designed to be included on your website contact page. It protects your Crisp Inbox against spam bots using a CAPTCHA ran by hCaptcha.
How can I setup the Ticket Center plugin?
The Ticket Center plugin lets you create a ticket dashboard linked to your Crisp, which you can include in your website. This guide goes through how to setup the Ticket Center on your website. It is designed to be included in authenticated areas of websites, eg. dashboards, where users are authenticated. Their email address must be known and verified.
How can I build Crisp plugins?
The Crisp platform is open for business! We allow any developer to extend its capabilities by building new plugins to add more features to Crisp apps, or connect Crisp with external platforms. It can even be your own platform, which you'd want to connect with Crisp.
How to embed Crisp inside a single-page app?
Crisp provides a Web SDK that provides Typescript bindings for the Crisp chatbox. This method is preferred when including Crisp in a single-page apps using Frameworks such as Angular, VueJS, React, NuxtJS or NextJS. Getting started Installation npm install --save crisp-sdk-web Basic Implementation To add Crisp on your website, you will firs
Technical and legal information
Crisp chatbox Cookie & IP policy
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](https://docs.crisp.chat/g
How can I whitelist Crisp servers?
Companies operating over filtered networks may need to whitelist our systems in order to be able to access Crisp. This ranges from the user agents we use to perform HTTP requests, our server IP addresses (inbound and outbound) and our domain names (useful for CSP policies).
Guides on common use-cases
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 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
How to Create a Conversation Inside Crisp from a Form on a Website?
Nowadays, using a form to capture customer or lead data is common. Especially on pages like contact page or landing pages. The thing is, these forms are, most of the time, sending the information to an inbox that is not shared. Here is how you can centralize the form's data inside Crisp. Making it easier for teams to answer and acknowledge customer or lead messages is one of the goals that Crisp is targeting. Through this article, we will show you the main steps to let you **catch the form'
Connect Crisp with external platforms
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 developers 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 s
How to connect a Dialogflow chatbot with Crisp?
In this tutorial, you will learn how to connect Dialogflow with Crisp. If you are a complete novice about Dialogflow chatbot platform or new to the Crisp API, no worries, everything will be explained. What is Dialogflow? Dialogflow is a complete platform for chatbots. It is based on natural language processing (NLP), a very powerful technology. Currently maintained by Google, it is one of the most used service to create chatbots. Bots created with Dialogflow can be integrated anywhere: m
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 leverage contact data in Crisp thanks to Google Tag Manager
In this article, we're going to see how you can use the DataLayer to activate some features as for example a chat support, that you can only display to a specific user base. For example, at Crisp, we could choose to only offer live chat support to users that are not under the basic plan. (which will never be the case, don't worry). Through this article, we will guide you on how you can take advantage of user attributes (also known as custom data or conversation data) to display the chatbox ba
How to send events from Crisp to Facebook Pixel?
This article explains how you can send Crisp's users events to Facebook using Facebook Pixel We will cover a few examples but regarding Facebook Pixel documentation 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
How to push a conversion to Google Ads from a Live Chat via Google Tag Manager?
This article explains how you can send Live chat's interactions to Google Ads and mark it as a conversion in your Google Ads account. This tutorial is done with the help of Google Tag Manager (GTM) We will cover a few examples but regarding Google Ads developper documentation, you'll be able to set a wide variety of use case. Depending on the way you use Crisp, you should be able to create events that will be flagged as conversions in Google Ads. If you want to have a deeper look at **all the