Crisp API Wrapper

The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.

Copyright 2026 Crisp IM SAS. See LICENSE for copying information.

• 📝 Implements: REST API Reference (V1) at revision: 29/01/2026
• 😘 Maintainers: @baptistejamin, @eliottvincent, @valeriansaliou

Installation

npm install --save crisp-api

Authentication

To authenticate against the API, obtain your authentication token keypair by following the REST API Authentication guide. You'll get a token keypair made of 2 values.

Keep your token keypair values private, and store them safely for long-term use.

Then, add authentication parameters to your client instance right after you create it:

var { Crisp } = require("crisp-api");
var CrispClient = new Crisp();

// Authenticate to API with your token (identifier, key)
// eg. CrispClient.authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
CrispClient.authenticateTier(tier, identifier, key);

// Now, you can use authenticated API sections.

Overview

You may follow the REST API Quickstart guide, which will get you running with the REST API in minutes.

var { Crisp } = require("crisp-api");
var CrispClient = new Crisp();

CrispClient.authenticateTier("plugin", identifier, key);

CrispClient.website.listConversations(websiteID, 1)
  .then(function(conversations) {
    console.log("Listed conversations:", conversations);
  })
  .catch(function(error) {
    console.error("Error listing conversations:", error);
  });

Examples

Create your own bot!

var { Crisp } = require("crisp-api");
var CrispClient = new Crisp();

CrispClient.authenticateTier("plugin", identifier, key);

// Notice: make sure to authenticate before listening for an event
CrispClient.on("message:send", function(message) {
  CrispClient.website.sendMessageInConversation(
    message.website_id, message.session_id,

    {
      type    : "text",
      content : "I'm a bot",
      from    : "operator", // or user
      origin  : "chat"
    }
  )
    .then(function(message) {
      console.log("Message sent:", message);
    })
    .catch(function(error) {
      console.error("Error sending message:", error);
    });
})
  .then(function() {
    console.error("Requested to listen to sent messages");
  })
  .catch(function(error) {
    console.error("Failed listening to sent messages:", error);
  });

Resource Methods

All the available Crisp API resources are fully implemented. Programmatic methods names are named after their label name in the REST API Reference.

All methods that you will most likely need when building a Crisp integration are prefixed with a star symbol (⭐).

⚠️ Note that, depending on your authentication token tier, which is either user, website or plugin, you may not be allowed to use all methods from the library. When in doubt, refer to the library method descriptions below. Most likely, you are using a plugin token.

---

Website

• Website Conversations
• Website Conversation
• Website People
• Website Helpdesk
• Website Operator
• Website Availability
• Website Analytics
• Website Batch
• Website Inbox
• Website Teams
• Website Verify
• Website Campaigns
• Website Campaign
• Website Connect

Plugin

• Plugin Connect
• Plugin Subscription

Plan

• Plan Subscription

Media

• Media Animation

Bucket

• Bucket URL

RTM Events

• Session Events
• Message Events
• People Events
• Campaign Events
• Browsing Events
• Call Events
• Widget Events
• Status Events
• Website Events
• Bucket Events
• Media Events
• Email Events
• Plugin Events

---

Website

• Website Conversations

  • ⭐ List Conversations: Reference

    • CrispClient.website.listConversations(websiteID, pageNumber, options)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      var options = {
        per_page: 50
      }
      
      CrispClient.website.listConversations(websiteID, pageNumber, options);

  • List Suggested Conversation Segments: Reference

    • CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber);

  • Delete Suggested Conversation Segment: Reference

    • CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var segment = "bug";
      
      CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment);

  • List Suggested Conversation Data Keys: Reference

    • CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber);

  • Delete Suggested Conversation Data Key: Reference

    • CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var key = "price";
      
      CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key);

  • List Spam Conversations: Reference

    • CrispClient.website.listSpamConversations(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listSpamConversations(websiteID, pageNumber);

  • Resolve Spam Conversation Content: Reference

    • CrispClient.website.resolveSpamConversationContent(websiteID, spamID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
      
      CrispClient.website.resolveSpamConversationContent(websiteID, spamID);

  • Submit Spam Conversation Decision: Reference

    • CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
      
      var action = "reject";
      
      CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action);

• Website Conversation

  • ⭐ Create A New Conversation: Reference

    • CrispClient.website.createNewConversation(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.createNewConversation(websiteID);

  • Check If Conversation Exists: Reference

    • CrispClient.website.checkConversationExists(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.checkConversationExists(websiteID, sessionID);

  • ⭐ Get A Conversation: Reference

    • CrispClient.website.getConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getConversation(websiteID, sessionID);

  • Remove A Conversation: Reference

    • CrispClient.website.removeConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.removeConversation(websiteID, sessionID);

  • Initiate A Conversation With Existing Session: Reference

    • CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID);

  • ⭐ Get Messages In Conversation: Reference

    • CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore, timestampAfter, timestampAround)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      // Either 'timestampBefore', 'timestampAfter' or 'timestampAround'
      var timestampBefore = 1641206011000;
      
      CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore);

  • ⭐ Send A Message In Conversation: Reference

    • CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var message = {
        "type": "text",
        "from": "operator",
        "origin": "chat",
        "content": "Hey there! Need help?"
      };
      
      CrispClient.website.sendMessageInConversation(websiteID, sessionID, message);

  • Get A Message In Conversation: Reference

    • CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var fingerprint = 524653764345;
      
      CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint);

  • Update A Message In Conversation: Reference

    • CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var fingerprint = 524653764345;
      
      var content = "Hey there! Need help?";
      
      CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content);

  • Remove A Message In Conversation: Reference

    • CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var fingerprint = 524653764345;
      
      CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint);

  • Compose A Message In Conversation: Reference

    • CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var compose = {
        "type": "start",
        "from": "operator"
      };
      
      CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose);

  • ⭐ Mark Messages As Read In Conversation: Reference

    • CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var read = {
        "from": "operator",
        "origin": "urn:crisp.im:slack:0",
        "fingerprints": [
          "5719231201"
        ]
      };
      
      CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read);

  • Mark Conversation As Unread: Reference

    • CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var unread = {
        "from": "operator"
      };
      
      CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread);

  • ⭐ Mark Messages As Delivered In Conversation: Reference

    • CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var delivered = {
        "from": "operator",
        "origin": "urn:crisp.im:slack:0",
        "fingerprints": [
          "5719231201"
        ]
      };
      
      CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered);

  • Update Conversation Open State: Reference

    • CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var opened = true;
      
      CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened);

  • ⭐ Get Conversation Routing Assign: Reference

    • CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getConversationRoutingAssign(websiteID, sessionID);

  • ⭐ Assign Conversation Routing: Reference

    • CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var assign = {
        "assigned": {
          "user_id": "a4c32c68-be91-4e29-8a05-976e93abbe3f"
        }
      };
      
      CrispClient.website.assignConversationRouting(websiteID, sessionID, assign);

  • Update Conversation Inbox: Reference

    • CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var inboxID = "bf6935c9-43b3-4f8e-87ea-175c1e1ed1a9";
      
      CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID);

  • ⭐ Get Conversation Metas: Reference

    • CrispClient.website.getConversationMetas(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getConversationMetas(websiteID, sessionID);

  • ⭐ Update Conversation Metas: Reference

    • CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var metas = {
        "nickname": "John Doe",
        "email": "john.doe@acme-inc.com",
        "segments": [
          "happy",
          "customer",
          "love"
        ],
        "data": {
          "type": "customer",
          "signup": "finished"
        }
      };
      
      CrispClient.website.updateConversationMetas(websiteID, sessionID, metas);

  • Get An Original Message In Conversation: Reference

    • CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var originalID = "2325a3c0-9b47-4fc6-b00e-111b752e44cd";
      
      CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID);

  • List Conversation Pages: Reference

    • CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var pageNumber = 1;
      
      CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber);

  • List Conversation Events: Reference

    • CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var pageNumber = 1;
      
      CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber);

  • List Conversation Files: Reference

    • CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var pageNumber = 1;
      
      CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber);

  • Get Conversation State: Reference

    • CrispClient.website.getConversationState(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getConversationState(websiteID, sessionID);

  • ⭐ Change Conversation State: Reference

    • CrispClient.website.changeConversationState(websiteID, sessionID, state, user, origin)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var state = "unresolved";
      
      CrispClient.website.changeConversationState(websiteID, sessionID, state);

  • Get Conversation Relations: Reference

    • CrispClient.website.getConversationRelations(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getConversationRelations(websiteID, sessionID);

  • Get Conversation Participants: Reference

    • CrispClient.website.getConversationParticipants(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getConversationParticipants(websiteID, sessionID);

  • Save Conversation Participants: Reference

    • CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var participants = {
        "participants": [
          {
            "type": "email",
            "target": "jane.doe@acme-inc.com"
          }
        ]
      };
      
      CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants);

  • Get Block Status For Conversation: Reference

    • CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getBlockStatusForConversation(websiteID, sessionID);

  • Block Incoming Messages For Conversation: Reference

    • CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked, user, origin)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var blocked = true;
      
      CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked);

  • Get Verify Status For Conversation: Reference

    • CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID);

  • Update Verify Status For Conversation: Reference

    • CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var verified = true;
      
      CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified);

  • Request Identity Verification For Conversation: Reference

    • CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var verification = {
        "identity": "email"
      };
      
      CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification);

  • Redeem Identity Verification Link For Conversation: Reference

    • CrispClient.website.redeemIdentityVerificationLinkForConversation(websiteID, sessionID, identity, token)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var verification = {
        "identity": "email",
        "token": "709691"
      };
      
      CrispClient.website.redeemIdentityVerificationLinkForConversation(websiteID, sessionID, verification);

  • Request Email Transcript For Conversation: Reference

    • CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var email = {
        "to": "operator",
        "email": "valerian@crisp.chat"
      };
      
      CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email);

  • Request Chatbox Binding Purge For Conversation: Reference

    • CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID);

  • Request User Feedback For Conversation: Reference

    • CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID);

  • List Browsing Sessions For Conversation: Reference

    • CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID);

  • Initiate Browsing Session For Conversation: Reference

    • CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID);

  • Send Action To An Existing Browsing Session: Reference

    • CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
      
      var action = "start";
      
      CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action);

  • Assist Existing Browsing Session: Reference

    • CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
      
      var assist = {
        "action": "mouse",
        "mouse": {
          "x": 0,
          "y": 784
        }
      };
      
      CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist);

  • Initiate New Call Session For Conversation: Reference

    • CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode, user, origin)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var mode = "audio";
      
      CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode);

  • Get Ongoing Call Session For Conversation: Reference

    • CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID);

  • Abort Ongoing Call Session For Conversation: Reference

    • CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID, user, origin)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
      
      CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID);

  • Transmit Signaling On Ongoing Call Session: Reference

    • CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
      
      var payload = {
        "type": "sdp",
        "payload": {}
      };
      
      CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload);

  • Request Tool Call For Conversation: Reference

    • CrispClient.website.requestToolCallForConversation(websiteID, sessionID, command, payload)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var command = "list_tools";
      
      CrispClient.website.requestToolCallForConversation(websiteID, sessionID, command);

  • Deliver Widget Button Action For Conversation: Reference

    • CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
      var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
      
      var value = {
        "section_id": "payments",
        "item_id": "refund_on_stripe",
        "data": {
          "invoice": "D-1929-X"
        }
      };
      
      CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value);

  • Deliver Widget Data Fetch Action For Conversation: Reference

    • CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
      var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
      
      var data = {
        "section_id": "payments",
        "item_id": "unpaid_balance",
        "action": "fetch",
        "data": {}
      };
      
      CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);

  • Deliver Widget Data Edit Action For Conversation: Reference

    • CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
      var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
      
      var data = {
        "section_id": "payments",
        "item_id": "unpaid_balance",
        "action": "fetch",
        "data": {}
      };
      
      CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);

  • Schedule A Reminder For Conversation: Reference

    • CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note, user, origin)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var note = {
        "date": "2018-05-29T09:00:00Z",
        "note": "Call this customer."
      };
      
      CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note);

  • Report Conversation: Reference

    • CrispClient.website.reportConversation(websiteID, sessionID, flag)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
      
      var flag = "spam";
      
      CrispClient.website.reportConversation(websiteID, sessionID, flag);

• Website People (these are your end-users)

  • Get People Statistics: Reference

    • CrispClient.website.getPeopleStatistics(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.getPeopleStatistics(websiteID);

  • List Suggested People Segments: Reference

    • CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber);

  • Delete Suggested People Segment: Reference

    • CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var segment = "poweruser";
      
      CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment);

  • List Suggested People Data Keys: Reference

    • CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber);

  • Delete Suggested People Data Key: Reference

    • CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var key = "price";
      
      CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key);

  • List Suggested People Events: Reference

    • CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber);

  • Delete Suggested People Event: Reference

    • CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var text = "Removed item from basket";
      
      CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text);

  • ⭐ List People Profiles: Reference

    • CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText);

  • ⭐ Add New People Profile: Reference

    • CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var peopleProfile = {
        "email": "valerian@crisp.chat",
        "person": {
          "nickname": "Valerian Saliou"
        }
      };
      
      CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile);

  • ⭐ Check If People Profile Exists: Reference

    • CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      CrispClient.website.checkPeopleProfileExists(websiteID, peopleID);

  • ⭐ Get People Profile: Reference

    • CrispClient.website.getPeopleProfile(websiteID, peopleID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      CrispClient.website.getPeopleProfile(websiteID, peopleID);

  • ⭐ Save People Profile: Reference

    • CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      var peopleProfile = {
        "email": "valerian@crisp.chat",
        "person": {
          "nickname": "Valerian Saliou"
        }
      };
      
      CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile);

  • ⭐ Update People Profile: Reference

    • CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      var peopleProfile = {
        "email": "valerian@crisp.chat",
        "person": {
          "nickname": "Valerian Saliou"
        }
      };
      
      CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile);

  • ⭐ Remove People Profile: Reference

    • CrispClient.website.removePeopleProfile(websiteID, peopleID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      CrispClient.website.removePeopleProfile(websiteID, peopleID);

  • List People Conversations: Reference

    • CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      var pageNumber = 1;
      
      CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber);

  • List People Campaigns: Reference

    • CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      var pageNumber = 1;
      
      CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber);

  • Add A People Event: Reference

    • CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      var peopleEvent = {
        "text": "Added item to basket",
        "data": {
          "price": 10.99,
          "currency": "USD"
        },
        "color": "red"
      };
      
      CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent);

  • List People Events: Reference

    • CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      var pageNumber = 1;
      
      CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber);

  • Get People Data: Reference

    • CrispClient.website.getPeopleData(websiteID, peopleID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      CrispClient.website.getPeopleData(websiteID, peopleID);

  • Save People Data: Reference

    • CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      var peopleData = {
        "data": {
          "type": "customer",
          "signup": "finished"
        }
      };
      
      CrispClient.website.savePeopleData(websiteID, peopleID, peopleData);

  • Update People Data: Reference

    • CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      var peopleData = {
        "data": {
          "signup": "finished"
        }
      };
      
      CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData);

  • Get People Subscription Status: Reference

    • CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID);

  • Update People Subscription Status: Reference

    • CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
      
      var peopleSubscription = {
        "email": true
      };
      
      CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription);

  • Export People Profiles: Reference

    • CrispClient.website.exportPeopleProfiles(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.exportPeopleProfiles(websiteID);

  • Import People Profiles: Reference

    • CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var profileImportSetup = {
        "url": "https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv",
        "mapping": [
          {
            "column": 1,
            "field": "email"
          },
          {
            "column": 2,
            "field": "person.nickname"
          }
        ],
        "options": {
          "column_separator": ";",
          "skip_header": true
        }
      };
      
      CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup);

👉 Notice: The peopleID argument can be an email or the peopleID.

• Website Helpdesk

  • Check If Helpdesk Exists: Reference

    • CrispClient.website.checkHelpdeskExists(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.checkHelpdeskExists(websiteID);

  • Resolve Helpdesk: Reference

    • CrispClient.website.resolveHelpdesk(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.resolveHelpdesk(websiteID);

  • Initialize Helpdesk: Reference

    • CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var name = "My Helpdesk";
      var domainBasic = "my-helpdesk";
      
      CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic);

  • Delete Helpdesk: Reference

    • CrispClient.website.deleteHelpdesk(websiteID, verify)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var verify = { method: "email", secret: "verification-secret" };
      
      CrispClient.website.deleteHelpdesk(websiteID, verify);

  • List Helpdesk Locales: Reference

    • CrispClient.website.listHelpdeskLocales(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listHelpdeskLocales(websiteID, pageNumber);

  • Add Helpdesk Locale: Reference

    • CrispClient.website.addHelpdeskLocale(websiteID, locale)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      
      CrispClient.website.addHelpdeskLocale(websiteID, locale);

  • Check If Helpdesk Locale Exists: Reference

    • CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      
      CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale);

  • Resolve Helpdesk Locale: Reference

    • CrispClient.website.resolveHelpdeskLocale(websiteID, locale)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      
      CrispClient.website.resolveHelpdeskLocale(websiteID, locale);

  • Delete Helpdesk Locale: Reference

    • CrispClient.website.deleteHelpdeskLocale(websiteID, locale)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      
      CrispClient.website.deleteHelpdeskLocale(websiteID, locale);

  • List Helpdesk Pages: Reference

    • CrispClient.website.listHelpdeskPages(websiteID, locale, contentType, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var pageNumber = 1;
      
      CrispClient.website.listHelpdeskPages(websiteID, locale, contentType, pageNumber);

  • Resolve Helpdesk Page Entity: Reference

    • CrispClient.website.resolveHelpdeskPageEntity(websiteID, locale, contentType, entityID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var entityID = "01959c8b-0c6e-7e4c-8dfb-6e0a420ac990";
      
      CrispClient.website.resolveHelpdeskPageEntity(websiteID, locale, contentType, entityID);

  • List Helpdesk Tree: Reference

    • CrispClient.website.listHelpdeskTree(websiteID, locale, contentType, pageNumber, subPath, searchTitle, filterDateStart, filterDateEnd)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var pageNumber = 1;
      var subPath = "guides";
      var searchTitle = "Getting started";
      var filterDateStart = "2025-01-01";
      var filterDateEnd = "2025-12-31";
      
      CrispClient.website.listHelpdeskTree(websiteID, locale, contentType, pageNumber, subPath, searchTitle, filterDateStart, filterDateEnd);

  • Create Helpdesk Tree Path: Reference

    • CrispClient.website.createHelpdeskTreePath(websiteID, locale, contentType, path)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      
      CrispClient.website.createHelpdeskTreePath(websiteID, locale, contentType, path);

  • Resolve Helpdesk Tree Path: Reference

    • CrispClient.website.resolveHelpdeskTreePath(websiteID, locale, contentType, path)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      
      CrispClient.website.resolveHelpdeskTreePath(websiteID, locale, contentType, path);

  • Update Helpdesk Tree Path: Reference

    • CrispClient.website.updateHelpdeskTreePath(websiteID, locale, contentType, path, update)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      var update = { action: "move", path: { to: "guides/getting-started" } };
      
      CrispClient.website.updateHelpdeskTreePath(websiteID, locale, contentType, path, update);

  • Delete Helpdesk Tree Path: Reference

    • CrispClient.website.deleteHelpdeskTreePath(websiteID, locale, contentType, path)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      
      CrispClient.website.deleteHelpdeskTreePath(websiteID, locale, contentType, path);

  • Resolve Helpdesk Tree Content: Reference

    • CrispClient.website.resolveHelpdeskTreeContent(websiteID, locale, contentType, path)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      
      CrispClient.website.resolveHelpdeskTreeContent(websiteID, locale, contentType, path);

  • Save Helpdesk Tree Content: Reference

    • CrispClient.website.saveHelpdeskTreeContent(websiteID, locale, contentType, path, content)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      var content = "# Getting started\n\nWelcome to our helpdesk.";
      
      CrispClient.website.saveHelpdeskTreeContent(websiteID, locale, contentType, path, content);

  • Resolve Helpdesk Tree Metadata: Reference

    • CrispClient.website.resolveHelpdeskTreeMetadata(websiteID, locale, contentType, path)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      
      CrispClient.website.resolveHelpdeskTreeMetadata(websiteID, locale, contentType, path);

  • Update Helpdesk Tree Metadata: Reference

    • CrispClient.website.updateHelpdeskTreeMetadata(websiteID, locale, contentType, path, metadata)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      var metadata = { title: "Getting started", state: { published: true } };
      
      CrispClient.website.updateHelpdeskTreeMetadata(websiteID, locale, contentType, path, metadata);

  • List Helpdesk Tree Alternates: Reference

    • CrispClient.website.listHelpdeskTreeAlternates(websiteID, locale, contentType, path)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      
      CrispClient.website.listHelpdeskTreeAlternates(websiteID, locale, contentType, path);

  • Update Helpdesk Tree Alternates: Reference

    • CrispClient.website.updateHelpdeskTreeAlternates(websiteID, locale, contentType, path, alternates)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      var alternates = { fr: "demarrage" };
      
      CrispClient.website.updateHelpdeskTreeAlternates(websiteID, locale, contentType, path, alternates);

  • Resolve Helpdesk Tree Page: Reference

    • CrispClient.website.resolveHelpdeskTreePage(websiteID, locale, contentType, path)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var path = "getting-started";
      
      CrispClient.website.resolveHelpdeskTreePage(websiteID, locale, contentType, path);

  • List Helpdesk History Changes: Reference

    • CrispClient.website.listHelpdeskHistoryChanges(websiteID, pageNumber, filterLocale, filterType, filterTreePath)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      var filterLocale = "en";
      var filterType = "articles";
      var filterTreePath = "getting-started";
      
      CrispClient.website.listHelpdeskHistoryChanges(websiteID, pageNumber, filterLocale, filterType, filterTreePath);

  • Resolve Helpdesk History Change: Reference

    • CrispClient.website.resolveHelpdeskHistoryChange(websiteID, changeId)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var changeId = "01959c8b-0c6e-7e4c-8dfb-6e0a420ac990";
      
      CrispClient.website.resolveHelpdeskHistoryChange(websiteID, changeId);

  • Cancel Helpdesk History Change: Reference

    • CrispClient.website.cancelHelpdeskHistoryChange(websiteID, changeId, action)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var changeId = "01959c8b-0c6e-7e4c-8dfb-6e0a420ac990";
      var action = "revert";
      
      CrispClient.website.cancelHelpdeskHistoryChange(websiteID, changeId, action);

  • Request Helpdesk Content Refresh: Reference

    • CrispClient.website.requestHelpdeskContentRefresh(websiteID, locale, contentType)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      
      CrispClient.website.requestHelpdeskContentRefresh(websiteID, locale, contentType);

  • Map Helpdesk Locale Feedback Ratings: Reference

    • CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, contentType, filterDateStart, filterDateEnd)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var filterDateStart = "2025-01-01";
      var filterDateEnd = "2025-12-31";
      
      CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, contentType, filterDateStart, filterDateEnd);

  • List Helpdesk Locale Feedbacks: Reference

    • CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, contentType, pageNumber, filterDateStart, filterDateEnd)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var pageNumber = 1;
      var filterDateStart = "2025-01-01";
      var filterDateEnd = "2025-12-31";
      
      CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, contentType, pageNumber, filterDateStart, filterDateEnd);

  • Import External Helpdesk To Locale: Reference

    • CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, contentType, externalImport)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      var externalImport = { helpdesk_url: "https://docs.example.com/" };
      
      CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, contentType, externalImport);

  • Export Helpdesk Locale Articles: Reference

    • CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale, contentType)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var locale = "en";
      var contentType = "articles";
      
      CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale, contentType);

  • List Helpdesk Redirections: Reference

    • CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber);

  • Add Helpdesk Redirection: Reference

    • CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var redirectionPath = "/old-page";
      var redirectionTarget = "/new-page";
      
      CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget);

  • Check If Helpdesk Redirection Exists: Reference

    • CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var redirectionId = "01959c8b-0c6e-7e4c-8dfb-6e0a420ac990";
      
      CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId);

  • Resolve Helpdesk Redirection: Reference

    • CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var redirectionId = "01959c8b-0c6e-7e4c-8dfb-6e0a420ac990";
      
      CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId);

  • Delete Helpdesk Redirection: Reference

    • CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var redirectionId = "01959c8b-0c6e-7e4c-8dfb-6e0a420ac990";
      
      CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId);

  • Resolve Helpdesk Settings: Reference

    • CrispClient.website.resolveHelpdeskSettings(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.resolveHelpdeskSettings(websiteID);

  • Save Helpdesk Settings: Reference

    • CrispClient.website.saveHelpdeskSettings(websiteID, settings)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var settings = { name: "My Helpdesk" };
      
      CrispClient.website.saveHelpdeskSettings(websiteID, settings);

  • Resolve Helpdesk Domain: Reference

    • CrispClient.website.resolveHelpdeskDomain(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.resolveHelpdeskDomain(websiteID);

  • Request Helpdesk Domain Change: Reference

    • CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var basic = "my-helpdesk";
      var custom = "help.example.com";
      
      CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom);

  • Generate Helpdesk Domain Setup Flow: Reference

    • CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var custom = "help.example.com";
      
      CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom);

• Website Base

  • Check If Website Exists: Reference

    • CrispClient.website.checkWebsiteExists(domain)

    • See Example

      CrispClient.website.checkWebsiteExists(domain);

  • Create Website: Reference

    • CrispClient.website.createWebsite(websiteData)

    • See Example

      CrispClient.website.createWebsite(websiteData);

  • Get A Website: Reference

    • CrispClient.website.getWebsite(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.getWebsite(websiteID);

  • Delete A Website: Reference

    • CrispClient.website.deleteWebsite(websiteID, verify)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var verify = {
        "method": "password",
        "secret": "MySuperSecurePassword";
      };
      
      CrispClient.website.deleteWebsite(websiteID, verify);

  • Abort Website Deletion: Reference

    • CrispClient.website.abortWebsiteDeletion(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.abortWebsiteDeletion(websiteID);

• Website Settings

  • Get Website Settings: Reference

    • CrispClient.website.getWebsiteSettings(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.getWebsiteSettings(websiteID);

  • Update Website Settings: Reference

    • CrispClient.website.updateWebsiteSettings(websiteID, settings)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var settings = {
        "name": "Crisp",
        "domain": "crisp.chat",
        "domain_alternates": [],
        "logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
        "audit": {
          "log": true
        },
        "contact": {
          "email": "contact@crisp.chat",
          "phone": "+33757905447"
        },
        "inbox": {
          "lock_removal": false,
          "force_operator_token": false,
          "locale": ""
        },
        "emails": {
          "rating": true,
          "transcript": true,
          "trackers": true,
          "junk_filter": true
        },
        "chatbox": {
          "tile": "default",
          "conversations": true,
          "wait_game": false,
          "website_logo": true,
          "last_operator_face": false,
          "ongoing_operator_face": true,
          "activity_metrics": true,
          "operator_privacy": false,
          "visitor_privacy": false,
          "availability_tooltip": true,
          "hide_vacation": false,
          "hide_on_away": false,
          "hide_on_mobile": false,
          "position_reverse": false,
          "email_visitors": false,
          "phone_visitors": false,
          "force_identify": false,
          "ignore_privacy": false,
          "visitor_compose": false,
          "file_transfer": true,
          "audio_record": true,
          "guard_level": "default",
          "mode_initial": "chat",
          "home": true,
          "overlay_search": true,
          "overlay_mode": false,
          "helpdesk_link": true,
          "helpdesk_only": false,
          "helpdesk_navigate": "deep",
          "status_health_dead": true,
          "check_domain": false,
          "color_theme": "blue",
          "color_mode": "auto",
          "layout_theme": "default",
          "text_theme": "default",
          "welcome_message": "default",
          "locale": "en",
          "allowed_pages": [],
          "blocked_pages": [
            "status/*/",
            "docs.crisp.chat/*",
            "crisp.chat/terms/",
            "https://crisp.chat/privacy/"
          ],
          "blocked_countries": [
            "IT"
          ],
          "blocked_locales": [
            "fa",
            "he"
          ],
          "blocked_ips": [
            "8.8.8.8",
            "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
            "192.168.1.1/24"
          ]
        }
      };
      
      CrispClient.website.updateWebsiteSettings(websiteID, settings);

• Website Operator

  • List Website Operators: Reference

    • CrispClient.website.listWebsiteOperators(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.listWebsiteOperators(websiteID);

  • List Last Active Website Operators: Reference

    • CrispClient.website.listLastActiveWebsiteOperators(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.listLastActiveWebsiteOperators(websiteID);

  • Flush Last Active Website Operators: Reference

    • CrispClient.website.flushLastActiveWebsiteOperators(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.flushLastActiveWebsiteOperators(websiteID);

  • Send Email To Website Operators: Reference

    • CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var emailData = {
        "recipient": "owners",
        "subject": "Plugin limits reached",
        "message": "Hi, you've reached the Slack plugin limits. Please contact our support team."
      };
      
      CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData);

  • Get A Website Operator: Reference

    • CrispClient.website.getWebsiteOperator(websiteID, userID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
      
      CrispClient.website.getWebsiteOperator(websiteID, userID);

  • Invite A Website Operator: Reference

    • CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var email = "julien@crisp.chat";
      var role = "member";
      
      var verify = {
        "method": "password",
        "secret": "MySuperSecurePassword";
      };
      
      CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);

  • Change Operator Membership: Reference

    • CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
      
      var title = {
        "role": "owner",
        "title": "CTO"
      };
      
      CrispClient.website.changeOperatorMembership(websiteID, userID, role, title);

  • Unlink Operator From Website: Reference

    • CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
      
      CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID);

• Website Visitors

  • Count Visitors: Reference

    • CrispClient.website.countVisitors(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.countVisitors(websiteID);

  • List Visitors: Reference

    • CrispClient.website.listVisitors(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listVisitors(websiteID, pageNumber);

  • Pinpoint Visitors On A Map: Reference

    • CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius);

  • Get Session Identifier From Token: Reference

    • CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904";
      
      CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID);

  • Count Blocked Visitors: Reference

    • CrispClient.website.countBlockedVisitors(websiteID)

  • Count Blocked Visitors In Rule: Reference

    • CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.countBlockedVisitorsInRule(websiteID, rule);

  • Clear Blocked Visitors In Rule: Reference

    • CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule);

• Website Availability

  • Get Website Availability Status: Reference

    • CrispClient.website.getWebsiteAvailabilityStatus(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.getWebsiteAvailabilityStatus(websiteID);

  • List Website Operator Availabilities: Reference

    • CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.listWebsiteOperatorAvailabilities(websiteID);

• Website Analytics

  • Generate Analytics: Reference

    • CrispClient.website.generateAnalytics(websiteID, query)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.generateAnalytics(websiteID, query);

• Website Batch

  • Batch Resolve Conversations: Reference

    • CrispClient.website.batchResolveConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "inbox_id": null,
      
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ]
      };
      
      CrispClient.website.batchResolveConversations(websiteID, operation);

  • Batch Unresolve Conversations: Reference

    • CrispClient.website.batchUnresolveConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ]
      };
      
      CrispClient.website.batchUnresolveConversations(websiteID, operation);

  • Batch Read Conversations: Reference

    • CrispClient.website.batchReadConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "inbox_id": null,
      
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ]
      };
      
      CrispClient.website.batchReadConversations(websiteID, operation);

  • Batch Unread Conversations: Reference

    • CrispClient.website.batchUnreadConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ]
      };
      
      CrispClient.website.batchUnreadConversations(websiteID, operation);

  • Batch Remove Conversations: Reference

    • CrispClient.website.batchRemoveConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "inbox_id": null,
      
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ]
      };
      
      CrispClient.website.batchRemoveConversations(websiteID, operation);

  • Batch Remove People: Reference

    • CrispClient.website.batchRemovePeople(websiteID, people)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var sessions = [
        "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
        "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
      ];
      
      CrispClient.website.batchRemoveConversations(websiteID, sessions);

  • Batch Report Conversations: Reference

    • CrispClient.website.batchReportConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ],
      
        "flag": "spam"
      };
      
      CrispClient.website.batchReportConversations(websiteID, operation);

  • Batch Block Conversations: Reference

    • CrispClient.website.batchBlockConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ],
      
        "blocked": true
      };
      
      CrispClient.website.batchBlockConversations(websiteID, operation);

  • Batch Routing Conversations: Reference

    • CrispClient.website.batchRoutingConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ],
      
        "assigned": {
          "user_id": "a4c32c68-be91-4e29-b97e-b3b6af886eaa"
        }
      };
      
      CrispClient.website.batchRoutingConversations(websiteID, operation);

  • Batch Inbox Conversations: Reference

    • CrispClient.website.batchInboxConversations(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ],
      
        "inbox_id": "d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31"
      };
      
      CrispClient.website.batchInboxConversations(websiteID, operation);

  • Batch Update Conversations Data: Reference

    • CrispClient.website.batchUpdateConversationsData(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ],
      
        "data": {
          "plan": "pro",
          "subscribed": true
        }
      };
      
      CrispClient.website.batchUpdateConversationsData(websiteID, operation);

  • Batch Update People Data: Reference

    • CrispClient.website.batchUpdatePeopleData(websiteID, people, data)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var people = {
        "profiles": [
          "eee8759d-52db-48e5-982d-3426e3566ce0"
        ]
      };
      
      var data = {
        "plan": "pro",
        "subscribed": true
      };
      
      CrispClient.website.batchUpdatePeopleData(websiteID, people, data);

  • Batch Update Conversations Segments: Reference

    • CrispClient.website.batchUpdateConversationsSegments(websiteID, operation)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var operation = {
        "sessions": [
          "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
          "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
        ],
      
        "segments": [
          "vip",
          "lead"
        ]
      };
      
      CrispClient.website.batchUpdateConversationsSegments(websiteID, operation);

  • Batch Update People Segments: Reference

    • CrispClient.website.batchUpdatePeopleSegments(websiteID, people, segments)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var people = {
        "profiles": [
          "eee8759d-52db-48e5-982d-3426e3566ce0"
        ]
      };
      
      var segments = [
        "vip",
        "lead"
      ];
      
      CrispClient.website.batchUpdatePeopleSegments(websiteID, people, segments);

• Website Inbox

  • List Inboxes: Reference

    • CrispClient.website.listInboxes(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listInboxes(websiteID, pageNumber);

  • Batch Order Inboxes: Reference

    • CrispClient.website.batchOrderInboxes(websiteID, orders)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var orders = [
        {
          "inbox_id": "d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31",
          "order": 1
        },
      
        {
          "inbox_id": "c058abfe-2881-4ff4-8f6a-6eb73e55385e",
          "order": 2
        }
      ];
      
      CrispClient.website.batchOrderInboxes(websiteID, orders);

  • Create A New Inbox: Reference

    • CrispClient.website.createNewInbox(websiteID, inbox)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var inbox = {
        "name": "VIP",
        "emoji": "⭐️",
        "order": 1,
      
        "operators": [
          "86a4fed0-2f5f-4713-a8ff-41d7f3e4a8f8",
          "e5cd7aa6-998f-4b8e-b7c5-3b546af87d15"
        ],
      
        "operator": "and",
      
        "conditions": [
          {
            "model": "session",
            "criterion": "segments",
            "operator": "eq",
      
            "query": [
              "vip"
            ]
          }
        ]
      };
      
      CrispClient.website.createNewInbox(websiteID, inbox);

  • Check If Inbox Exists: Reference

    • CrispClient.website.checkInboxExists(websiteID, inboxID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var inboxID = "d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31";
      
      CrispClient.website.checkInboxExists(websiteID, inboxID);

  • Get Inbox: Reference

    • CrispClient.website.getInbox(websiteID, inboxID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var inboxID = "d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31";
      
      CrispClient.website.getInbox(websiteID, inboxID);

  • Save Inbox: Reference

    • CrispClient.website.saveInbox(websiteID, inboxID, inbox)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var inboxID = "d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31";
      
      var inbox = {
        "name": "VIP",
        "emoji": "⭐️",
        "order": 1,
      
        "operators": [
          "86a4fed0-2f5f-4713-a8ff-41d7f3e4a8f8",
          "e5cd7aa6-998f-4b8e-b7c5-3b546af87d15"
        ],
      
        "operator": "and",
      
        "conditions": [
          {
            "model": "session",
            "criterion": "segments",
            "operator": "eq",
      
            "query": [
              "vip"
            ]
          }
        ]
      };
      
      CrispClient.website.saveInbox(websiteID, inboxID, inbox);

  • Delete Inbox: Reference

    • CrispClient.website.deleteInbox(websiteID, inboxID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var inboxID = "d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31";
      
      CrispClient.website.deleteInbox(websiteID, inboxID);

• Website Teams

  • List Teams: Reference

    • CrispClient.website.listTeams(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listTeams(websiteID, pageNumber);

  • Create A New Team: Reference

    • CrispClient.website.createNewTeam(websiteID, team)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var team = {
        "name": "Sales",
        "emoji": "💰",
      
        "operators": [
          "a4c32c68-be91-4e29-8a05-976e93abbe3f"
        ]
      };
      
      CrispClient.website.createNewTeam(websiteID, team);

  • Check If Team Exists: Reference

    • CrispClient.website.checkTeamExists(websiteID, teamID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
      
      CrispClient.website.checkTeamExists(websiteID, teamID);

  • Get Team: Reference

    • CrispClient.website.getTeam(websiteID, teamID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
      
      CrispClient.website.getTeam(websiteID, teamID);

  • Save Team: Reference

    • CrispClient.website.saveTeam(websiteID, teamID, team)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
      
      var team = {
        "name": "Sales",
        "emoji": "💰",
      
        "operators": [
          "a4c32c68-be91-4e29-8a05-976e93abbe3f"
        ]
      };
      
      CrispClient.website.saveTeam(websiteID, teamID, team);

  • Delete Team: Reference

    • CrispClient.website.deleteTeam(websiteID, teamID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var teamID = "d09fbd42-e517-45a4-9776-ba8226e00ba8";
      
      CrispClient.website.deleteTeam(websiteID, teamID);

• Website Verify

  • Get Verify Settings: Reference

    • CrispClient.website.getVerifySettings(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.getVerifySettings(websiteID);

  • Update Verify Settings: Reference

    • CrispClient.website.updateVerifySettings(websiteID, settings)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var settings = {
        "enabled": true
      };
      
      CrispClient.website.updateVerifySettings(websiteID, settings);

  • Get Verify Key: Reference

    • CrispClient.website.getVerifyKey(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.getVerifyKey(websiteID);

  • Roll Verify Key: Reference

    • CrispClient.website.rollVerifyKey(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.rollVerifyKey(websiteID);

• Website Campaigns

  • List Campaigns: Reference

    • CrispClient.website.listCampaigns(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listCampaigns(websiteID, pageNumber);

  • List Campaign Tags: Reference

    • CrispClient.website.listCampaignTags(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.listCampaignTags(websiteID);

  • List Campaign Templates: Reference

    • CrispClient.website.listCampaignTemplates(websiteID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pageNumber = 1;
      
      CrispClient.website.listCampaignTemplates(websiteID, pageNumber);

  • Create A New Campaign Template: Reference

    • CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var templateName = {
        "name": "HTML Template",
        "format": "html"
      };
      
      CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName);

  • Check If Campaign Template Exists: Reference

    • CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
      
      CrispClient.website.checkCampaignTemplateExists(websiteID, templateID);

  • Get A Campaign Template: Reference

    • CrispClient.website.getCampaignTemplate(websiteID, templateID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
      
      CrispClient.website.getCampaignTemplate(websiteID, templateID);

  • Save A Campaign Template: Reference

    • CrispClient.website.saveCampaignTemplate(websiteID, templateID, template)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
      
      var template = {
        "name": "HTML Template",
        "format": "html",
        "content": "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>"
      };
      
      CrispClient.website.saveCampaignTemplate(websiteID, templateID, template);

  • Update A Campaign Template: Reference

    • CrispClient.website.updateCampaignTemplate(websiteID, templateID, template)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
      
      var template = "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>";
      
      CrispClient.website.updateCampaignTemplate(websiteID, templateID, template);

  • Remove A Campaign Template: Reference

    • CrispClient.website.removeCampaignTemplate(websiteID, templateID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
      
      CrispClient.website.removeCampaignTemplate(websiteID, templateID);

• Website Campaign

  • Create A New Campaign: Reference

    • CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      var campaignName = {
        "type": "one-shot",
        "name": "Welcome!"
      };
      
      CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName);

  • Check If Campaign Exists: Reference

    • CrispClient.website.checkCampaignExists(websiteID, campaignID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      CrispClient.website.checkCampaignExists(websiteID, campaignID);

  • Get A Campaign: Reference

    • CrispClient.website.getCampaign(websiteID, campaignID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      CrispClient.website.getCampaign(websiteID, campaignID);

  • Save A Campaign: Reference

    • CrispClient.website.saveCampaign(websiteID, campaignID, campaign)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      var campaign = {
        "type": "one-shot",
        "format": "markdown",
        "name": "Welcome!",
        "sender": {
          "user_id": "aa0b64dd-9fb4-4db9-80d6-5a49eb84087b"
        },
        "recipients": {
          "type": "all"
        },
        "message": "*Hey there*, welcome on Crisp!",
        "options": {
          "deliver_to_chatbox": true,
          "deliver_to_email": true,
          "sender_name_website": false,
          "sender_email_reply": null,
          "tracking": true
        }
      };
      
      CrispClient.website.saveCampaign(websiteID, campaignID, campaign);

  • Update A Campaign: Reference

    • CrispClient.website.updateCampaign(websiteID, campaignID, campaign)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      var campaign = {
        "message": "*Hey there*, welcome on Crisp folks!"
      };
      
      CrispClient.website.updateCampaign(websiteID, campaignID, campaign);

  • Remove A Campaign: Reference

    • CrispClient.website.removeCampaign(websiteID, campaignID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      CrispClient.website.removeCampaign(websiteID, campaignID);

  • Dispatch A Campaign: Reference

    • CrispClient.website.dispatchCampaign(websiteID, campaignID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      CrispClient.website.dispatchCampaign(websiteID, campaignID);

  • Resume A Campaign: Reference

    • CrispClient.website.resumeCampaign(websiteID, campaignID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      CrispClient.website.resumeCampaign(websiteID, campaignID);

  • Pause A Campaign: Reference

    • CrispClient.website.pauseCampaign(websiteID, campaignID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      CrispClient.website.pauseCampaign(websiteID, campaignID);

  • Test A Campaign: Reference

    • CrispClient.website.testCampaign(websiteID, campaignID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      
      CrispClient.website.testCampaign(websiteID, campaignID);

  • List Campaign Recipients: Reference

    • CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      var pageNumber = 1;
      
      CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber);

  • List Campaign Statistics: Reference

    • CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
      var pageNumber = 1;
      
      CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber);

• Website Connect

  • Get Connect Endpoints: Reference

    • CrispClient.website.getConnectEndpoints(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.website.getConnectEndpoints(websiteID);

Plugin

• Plugin Connect

  • ⭐ Get Connect Account: Reference

    • CrispClient.plugin.getConnectAccount()

    • See Example

      CrispClient.plugin.getConnectAccount();

  • ⭐ Check Connect Session Validity: Reference

    • CrispClient.plugin.checkConnectSessionValidity()

    • See Example

      CrispClient.plugin.checkConnectSessionValidity();

  • ⭐ List All Connect Websites: Reference

    • CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, includePlan)

    • See Example

      var pageNumber = 1;
      
      CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, includePlan);

  • ⭐ List Connect Websites Since: Reference

    • CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured, includePlan)

    • See Example

      var dateSince = "2023-08-16T09:00:00Z";
      
      CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured, includePlan);

  • ⭐ Get Connect Endpoints: Reference

    • CrispClient.plugin.getConnectEndpoints()

    • See Example

      CrispClient.plugin.getConnectEndpoints();

• Plugin Subscription

  • List All Active Subscriptions: Reference

    • CrispClient.plugin.listAllActiveSubscriptions()

    • See Example

      CrispClient.plugin.listAllActiveSubscriptions();

  • List Subscriptions For A Website: Reference

    • CrispClient.plugin.listSubscriptionsForWebsite(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.plugin.listSubscriptionsForWebsite(websiteID);

  • Get Subscription Details: Reference

    • CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID);

  • Subscribe Website To Plugin: Reference

    • CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      var pluginID = "98454664-9f7d-4d95-a9ce-f37356f5e65a";
      
      CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID);

  • Unsubscribe Plugin From Website: Reference

    • CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID);

  • Get Subscription Settings: Reference

    • CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID);

  • Save Subscription Settings: Reference

    • CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      var settings = {
        "chatbox": {
          "25": "#bbbbbb"
        }
      };
      
      CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings);

  • Update Subscription Settings: Reference

    • CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      var settings = {
        "chatbox": {
          "25": "#bbbbbb"
        }
      };
      
      CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings);

  • Get Plugin Usage Bills: Reference

    • CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      CrispClient.plugin.getPluginUsageBills(websiteID, pluginID);

  • Report Plugin Usage To Bill: Reference

    • CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      var usage = {
        "name": "Paid messages sent",
        "units": 250,
        "price": 0.10
      };
      
      CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage);

  • Get Plugin Attest Provenance: Reference

    • CrispClient.plugin.getPluginAttestProvenance(websiteID, pluginID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      CrispClient.plugin.getPluginAttestProvenance(websiteID, pluginID);

  • Forward Plugin Payload To Channel: Reference

    • CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      var payload = {
        "namespace": "bot:step",
        "payload": {
          "step": 1
        }
      };
      
      CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload);

  • Dispatch Plugin Event: Reference

    • CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
      
      var payload = {
        "name": "bot-is-running",
        "data": {
          "bot": "Sales",
          "email": "valerian@crisp.chat"
        }
      };
      
      CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload);

Plan

• Plan Subscription

  • List All Active Plan Subscriptions: Reference

    • CrispClient.plan.listAllActiveSubscriptions()

    • See Example

      CrispClient.plan.listAllActiveSubscriptions();

  • Get Plan Subscription For A Website: Reference

    • CrispClient.plan.getPlanSubscriptionForWebsite(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.plan.getPlanSubscriptionForWebsite(websiteID);

  • Subscribe Website To Plan: Reference

    • CrispClient.plan.subscribeWebsiteToPlan(websiteID, planID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var planID = "d678dbc1-e49d-47d3-92f2-c436f5b0e4a5";
      
      CrispClient.plan.subscribeWebsiteToPlan(websiteID, planID);

  • Unsubscribe Plan From Website: Reference

    • CrispClient.plan.unsubscribePlanFromWebsite(websiteID)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      
      CrispClient.plan.unsubscribePlanFromWebsite(websiteID);

  • Change Bill Period For Website Plan Subscription: Reference

    • CrispClient.plan.changeBillPeriodForWebsitePlanSubscription(websiteID, period)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var period = "yearly";
      
      CrispClient.plan.changeBillPeriodForWebsitePlanSubscription(websiteID, period);

  • Check Coupon Availability For Website Plan Subscription: Reference

    • CrispClient.plan.checkCouponAvailabilityForWebsitePlanSubscription(websiteID, code)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var code = "CRISP+AWESOME";
      
      CrispClient.plan.checkCouponAvailabilityForWebsitePlanSubscription(websiteID, code);

  • Redeem Coupon For Website Plan Subscription: Reference

    • CrispClient.plan.redeemCouponForWebsitePlanSubscription(websiteID, code)

    • See Example

      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
      var code = "CRISP+AWESOME";
      
      CrispClient.plan.redeemCouponForWebsitePlanSubscription(websiteID, code);

Media

• Media Animation

  • List Animation Medias: Reference

    • CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)

    • See Example

      var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3";
      var pageNumber = 1;
      
      CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery);

Bucket

• Bucket URL

  • Generate Bucket URL: Reference

    • CrispClient.bucket.generateBucketURL(data)

    • See Example

      CrispClient.bucket.generateBucketURL(data);

Realtime Events

You can bind to realtime events from Crisp, in order to get notified of incoming messages and updates in websites.

You won't receive any event if you don't explicitly subscribe to realtime events, as the library doesn't connect to the realtime backend automatically.

There are two ways to receive realtime events:

1. Using Web Hooks (⭐ recommended)
2. Using WebSockets with the RTM API

Before you start with RTM events, please consider the following:

• You won't receive any event if you don't explicitly subscribe to realtime events using CrispClient.on(), as the library doesn't connect to the realtime backend automatically. This method returns a Promise object.
• Whenever the list of websites that your authentication token is entitled to receive events for changes, you will need to call CrispClient.rebindSocket(). This method also returns a Promise object. This only applies to WebSockets with the RTM API.

Receive realtime events

Receive events over Web Hooks

To start listening for events and bind a handler, check out the events over Web Hooks example.

You will need to adjust your code so that:

1. The RTM events mode is set to Web Hooks: CrispClient.setRtmMode("webhooks")
2. Your HTTP endpoint mounts a route listening for POST requests, and upon receiving requests:
   1. It verifies the requests with: CrispClient.verifyHook(secret, body, timestamp, signature)
   2. It receives the Web Hook with: CrispClient.receiveHook(body)

Plugin Web Hooks will need to be configured first for this to work. Check out our Web Hooks Quickstart guide and our Web Hooks Reference to get started.

Receive events over WebSockets (RTM API)

To start listening for events and bind a handler, check out the events over WebSockets example.

You will need to adjust your code so that:

1. The RTM events mode is set to WebSockets: CrispClient.setRtmMode("websockets")

Available realtime events

Available events are listed below:

• Session Events: Reference

  • Session Update Availability:
    • session:update_availability
  • Session Update Verify:
    • session:update_verify
  • Session Request Initiated:
    • session:request:initiated
  • Session Set Email:
    • session:set_email
  • Session Set Phone:
    • session:set_phone
  • Session Set Address:
    • session:set_address
  • Session Set Subject:
    • session:set_subject
  • Session Set Avatar:
    • session:set_avatar
  • Session Set Nickname:
    • session:set_nickname
  • Session Set Origin:
    • session:set_origin
  • Session Set Data:
    • session:set_data
  • Session Sync Pages:
    • session:sync:pages
  • Session Sync Events:
    • session:sync:events
  • Session Sync Capabilities:
    • session:sync:capabilities
  • Session Sync Geolocation:
    • session:sync:geolocation
  • Session Sync System:
    • session:sync:system
  • Session Sync Network:
    • session:sync:network
  • Session Sync Timezone:
    • session:sync:timezone
  • Session Sync Locales:
    • session:sync:locales
  • Session Sync Rating:
    • session:sync:rating
  • Session Sync Topic:
    • session:sync:topic
  • Session Set State:
    • session:set_state
  • Session Set Block:
    • session:set_block
  • Session Set Segments:
    • session:set_segments
  • Session Set Opened:
    • session:set_opened
  • Session Set Closed:
    • session:set_closed
  • Session Set Participants:
    • session:set_participants
  • Session Set Mentions:
    • session:set_mentions
  • Session Set Routing:
    • session:set_routing
  • Session Set Inbox:
    • session:set_inbox
  • Session Removed:
    • session:removed
  • Session Error:
    • session:error

• Message Events: Reference

  • Message Updated:
    • message:updated
  • Message Send:
    • message:send
  • Message Received:
    • message:received
  • Message Removed:
    • message:removed
  • Message Compose Send:
    • message:compose:send
  • Message Compose Receive:
    • message:compose:receive
  • Message Acknowledge Read Send:
    • message:acknowledge:read:send
  • Message Acknowledge Read Received:
    • message:acknowledge:read:received
  • Message Acknowledge Unread Send:
    • message:acknowledge:unread:send
  • Message Acknowledge Delivered:
    • message:acknowledge:delivered
  • Message Acknowledge Ignored:
    • message:acknowledge:ignored
  • Message Notify Unread Send:
    • message:notify:unread:send
  • Message Notify Unread Received:
    • message:notify:unread:received

• Spam Events: Reference

  • Spam Message:
    • spam:message
  • Spam Decision:
    • spam:decision

• People Events: Reference

  • People Profile Created:
    • people:profile:created
  • People Profile Updated:
    • people:profile:updated
  • People Profile Removed:
    • people:profile:removed
  • People Bind Session:
    • people:bind:session
  • People Sync Profile:
    • people:sync:profile
  • People Import Progress:
    • people:import:progress
  • People Import Done:
    • people:import:done

• Campaign Events: Reference

  • Campaign Progress:
    • campaign:progress
  • Campaign Dispatched:
    • campaign:dispatched
  • Campaign Running:
    • campaign:running

• Browsing Events: Reference

  • Browsing Request Initiated:
    • browsing:request:initiated
  • Browsing Request Rejected:
    • browsing:request:rejected

• Call Events: Reference

  • Call Request Initiated:
    • call:request:initiated
  • Call Request Rejected:
    • call:request:rejected

• Identity Events: Reference

  • Identity Verify Request:
    • identity:verify:request

• Widget Events: Reference

  • Widget Action Processed:
    • widget:action:processed

• Status Events: Reference

  • Status Health Changed:
    • status:health:changed

• Website Events: Reference

  • Website Update Visitors Count:
    • website:update_visitors_count
  • Website Update Operators Availability:
    • website:update_operators_availability
  • Website Users Available:
    • website:users:available

• Bucket Events: Reference

  • Bucket URL Upload Generated:
    • bucket:url:upload:generated
  • Bucket URL Avatar Generated:
    • bucket:url:avatar:generated
  • Bucket URL Website Generated:
    • bucket:url:website:generated
  • Bucket URL Campaign Generated:
    • bucket:url:campaign:generated
  • Bucket URL Helpdesk Generated:
    • bucket:url:helpdesk:generated
  • Bucket URL Status Generated:
    • bucket:url:status:generated
  • Bucket URL Processing Generated:
    • bucket:url:processing:generated

• Media Events: Reference

  • Media Animation Listed:
    • media:animation:listed

• Email Events: Reference

  • Email Subscribe:
    • email:subscribe
  • Email Track View:
    • email:track:view

• Plugin Events: Reference

  • Plugin Channel:
    • plugin:channel
  • Plugin Event:
    • plugin:event
  • Plugin Subscription Updated:
    • plugin:subscription:updated
  • Plugin Settings Saved:
    • plugin:settings:saved

• Plan Events: Reference

  • Plan Subscription Updated:
    • plan:subscription:updated