:zap: Crisp API Node Wrapper
The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.
Copyright 2023 Crisp IM SAS. See LICENSE for copying information.
npm install --save crisp-api
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 plugin token (identifier, key)
// eg. CrispClient.authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
CrispClient.authenticateTier("plugin", identifier, key);
// Now, you can use authenticated API sections.
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);
});
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);
});
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
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.
⭐ List Conversations [user
, plugin
]: Reference
CrispClient.website.listConversations(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listConversations(websiteID, pageNumber);
List Suggested Conversation Segments [user
, plugin
]: Reference
CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber);
Delete Suggested Conversation Segment [user
, plugin
]: Reference
CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var segment = "bug";
CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment);
List Suggested Conversation Data Keys [user
, plugin
]: Reference
CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber);
Delete Suggested Conversation Data Key [user
, plugin
]: Reference
CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var key = "price";
CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key);
⭐ Create A New Conversation [user
, plugin
]: Reference
CrispClient.website.createNewConversation(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.createNewConversation(websiteID);
Check If Conversation Exists [user
, plugin
]: Reference
CrispClient.website.checkConversationExists(websiteID, sessionID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.checkConversationExists(websiteID, sessionID);
⭐ Get A Conversation [user
, plugin
]: Reference
CrispClient.website.getConversation(websiteID, sessionID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversation(websiteID, sessionID);
Remove A Conversation [user
, plugin
]: Reference
CrispClient.website.removeConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID);
⭐ Get Messages In Conversation [user
, plugin
]: Reference
CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var timestampBefore = 1641206011000;
CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore);
⭐ Send A Message In Conversation [user
, plugin
]: Reference
CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)
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 [user
, plugin
]: Reference
CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)
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 [user
, plugin
]: Reference
CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)
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 [user
, plugin
]: Reference
CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint)
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 [user
, plugin
]: Reference
CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)
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 [user
, plugin
]: Reference
CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)
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 Messages As Delivered In Conversation [user
, plugin
]: Reference
CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)
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 [user
, plugin
]: Reference
CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)
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 [user
, plugin
]: Reference
CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationRoutingAssign(websiteID, sessionID);
⭐ Assign Conversation Routing [user
, plugin
]: Reference
CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)
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);
⭐ Get Conversation Metas [user
, plugin
]: Reference
CrispClient.website.getConversationMetas(websiteID, sessionID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationMetas(websiteID, sessionID);
⭐ Update Conversation Metas [user
, plugin
]: Reference
CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var metas = {
"nickname": "John Doe",
"email": "[email protected]",
"segments": [
"happy",
"customer",
"love"
],
"data": {
"type": "customer",
"signup": "finished"
}
};
CrispClient.website.updateConversationMetas(websiteID, sessionID, metas);
Get An Original Message In Conversation [user
, plugin
]: Reference
CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)
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 [user
, plugin
]: Reference
CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)
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 [user
, plugin
]: Reference
CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)
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 [user
, plugin
]: Reference
CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber)
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 [user
, plugin
]: Reference
CrispClient.website.getConversationState(websiteID, sessionID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationState(websiteID, sessionID);
⭐ Change Conversation State [user
, plugin
]: Reference
CrispClient.website.changeConversationState(websiteID, sessionID, state)
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 Participants [user
, plugin
]: Reference
CrispClient.website.getConversationParticipants(websiteID, sessionID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationParticipants(websiteID, sessionID);
Save Conversation Participants [user
, plugin
]: Reference
CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var participants = {
"participants": [
{
"type": "email",
"target": "[email protected]"
}
]
};
CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants);
Get Block Status For Conversation [user
, plugin
]: Reference
CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked)
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 [user
, plugin
]: Reference
CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified)
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 Email Transcript For Conversation [user
, plugin
]: Reference
CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var email = {
"to": "operator",
"email": "[email protected]"
};
CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email);
Request Chatbox Binding Purge For Conversation [user
, plugin
]: Reference
CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)
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 [user
, plugin
]: Reference
CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)
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 [user
, plugin
]: Reference
CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode)
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 [user
, plugin
]: Reference
CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)
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 [user
, plugin
]: Reference
CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID)
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 [user
, plugin
]: Reference
CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)
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);
Deliver Widget Button Action For Conversation [user
]: Reference
CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)
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 [user
]: Reference
CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)
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 [user
]: Reference
CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)
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 [user
, plugin
]: Reference
CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note)
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);
Get People Statistics [user
, plugin
]: Reference
CrispClient.website.getPeopleStatistics(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getPeopleStatistics(websiteID);
List Suggested People Segments [user
, plugin
]: Reference
CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber);
Delete Suggested People Segment [user
, plugin
]: Reference
CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var segment = "poweruser";
CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment);
List Suggested People Data Keys [user
, plugin
]: Reference
CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber);
Delete Suggested People Data Key [user
, plugin
]: Reference
CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var key = "price";
CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key);
List Suggested People Events [user
, plugin
]: Reference
CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber);
Delete Suggested People Event [user
, plugin
]: Reference
CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var text = "Removed item from basket";
CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text);
⭐ List People Profiles [user
, plugin
]: Reference
CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText);
⭐ Add New People Profile [user
, plugin
]: Reference
CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleProfile = {
"email": "[email protected]",
"person": {
"nickname": "Valerian Saliou"
}
};
CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile);
⭐ Check If People Profile Exists [user
, plugin
]: Reference
CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.checkPeopleProfileExists(websiteID, peopleID);
⭐ Get People Profile [user
, plugin
]: Reference
CrispClient.website.getPeopleProfile(websiteID, peopleID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.getPeopleProfile(websiteID, peopleID);
⭐ Save People Profile [user
, plugin
]: Reference
CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleProfile = {
"email": "[email protected]",
"person": {
"nickname": "Valerian Saliou"
}
};
CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile);
⭐ Update People Profile [user
, plugin
]: Reference
CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleProfile = {
"email": "[email protected]",
"person": {
"nickname": "Valerian Saliou"
}
};
CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile);
⭐ Remove People Profile [user
, plugin
]: Reference
CrispClient.website.removePeopleProfile(websiteID, peopleID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.removePeopleProfile(websiteID, peopleID);
List People Conversations [user
, plugin
]: Reference
CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)
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 [user
]: Reference
CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)
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 [user
, plugin
]: Reference
CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)
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 [user
, plugin
]: Reference
CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)
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 [user
, plugin
]: Reference
CrispClient.website.getPeopleData(websiteID, peopleID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.getPeopleData(websiteID, peopleID);
Save People Data [user
, plugin
]: Reference
CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)
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 [user
, plugin
]: Reference
CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)
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 [user
, plugin
]: Reference
CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID);
Update People Subscription Status [user
, plugin
]: Reference
CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)
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 [user
]: Reference
CrispClient.website.exportPeopleProfiles(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.exportPeopleProfiles(websiteID);
Import People Profiles [user
]: Reference
CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)
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
.
Check If Helpdesk Exists [user
, plugin
]: Reference
CrispClient.website.checkHelpdeskExists(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.checkHelpdeskExists(websiteID);
Resolve Helpdesk [user
, plugin
]: Reference
CrispClient.website.resolveHelpdesk(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.resolveHelpdesk(websiteID);
Initialize Helpdesk [user
]: Reference
CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var name = "Valerian Helpdesk";
var domainBasic = "valerian";
CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic);
Delete Helpdesk [user
]: Reference
CrispClient.website.deleteHelpdesk(websiteID, verify)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var verify = "MySuperSecurePassword";
CrispClient.website.deleteHelpdesk(websiteID, verify);
List Helpdesk Locales [user
, plugin
]: Reference
CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options={})
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, {
order_visits : "1"
});
Add Helpdesk Locale [user
, plugin
]: Reference
CrispClient.website.addHelpdeskLocale(websiteID, locale)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.addHelpdeskLocale(websiteID, locale);
Check If Helpdesk Locale Exists [user
, plugin
]: Reference
CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale);
Resolve Helpdesk Locale [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskLocale(websiteID, locale)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.resolveHelpdeskLocale(websiteID, locale);
Delete Helpdesk Locale [user
, plugin
]: Reference
CrispClient.website.deleteHelpdeskLocale(websiteID, locale)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.deleteHelpdeskLocale(websiteID, locale);
List Helpdesk Locale Articles [user
, plugin
]: Reference
CrispClient.website.listHelpdeskLocaleArticles(websiteID, locale, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleArticles(websiteID, locale, pageNumber);
Add A New Helpdesk Locale Article [user
, plugin
]: Reference
CrispClient.website.addNewHelpdeskLocaleArticle(websiteID, locale, title)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var title = "How to use $crisp JavaScript SDK?";
CrispClient.website.addNewHelpdeskLocaleArticle(websiteID, locale, title);
Check If Helpdesk Locale Article Exists [user
, plugin
]: Reference
CrispClient.website.checkHelpdeskLocaleArticleExists(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.checkHelpdeskLocaleArticleExists(websiteID, locale, articleId);
Resolve Helpdesk Locale Article [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskLocaleArticle(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.resolveHelpdeskLocaleArticle(websiteID, locale, articleId);
Save Helpdesk Locale Article [user
, plugin
]: Reference
CrispClient.website.saveHelpdeskLocaleArticle(websiteID, locale, articleId, article)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var article = {
"title": "How to use $crisp JavaScript SDK?",
"description": null,
"content": "Crisp lets you create your customized chatbox easily. **It's easy to setup**.",
"featured": false,
"order": 1
};
CrispClient.website.saveHelpdeskLocaleArticle(websiteID, locale, articleId, article);
Update Helpdesk Locale Article [user
, plugin
]: Reference
CrispClient.website.updateHelpdeskLocaleArticle(websiteID, locale, articleId, article)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var article = {
"content": "Crisp lets you create your customized chatbox easily. **It's easy to setup**."
};
CrispClient.website.updateHelpdeskLocaleArticle(websiteID, locale, articleId, article);
Delete Helpdesk Locale Article [user
, plugin
]: Reference
CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId);
Resolve Helpdesk Locale Article Page [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId);
Resolve Helpdesk Locale Article Category [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId);
Update Helpdesk Locale Article Category [user
, plugin
]: Reference
CrispClient.website.updateHelpdeskLocaleArticleCategory(websiteID, locale, articleId, categoryId, sectionId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var categoryId = "00d344a3-8948-45b5-9bc4-82ec249fcd44";
CrispClient.website.updateHelpdeskLocaleArticleCategory(websiteID, locale, articleId, categoryId);
List Helpdesk Locale Article Alternates [user
, plugin
]: Reference
CrispClient.website.listHelpdeskLocaleArticleAlternates(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.listHelpdeskLocaleArticleAlternates(websiteID, locale, articleId);
Check If Helpdesk Locale Article Alternate Exists [user
, plugin
]: Reference
CrispClient.website.checkHelpdeskLocaleArticleAlternateExists(websiteID, locale, articleId, localeLinked)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
CrispClient.website.checkHelpdeskLocaleArticleAlternateExists(websiteID, locale, articleId, localeLinked);
Resolve Helpdesk Locale Article Alternate [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
CrispClient.website.resolveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked);
Save Helpdesk Locale Article Alternate [user
, plugin
]: Reference
CrispClient.website.saveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked, articleIdLinked)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
var articleIdLinked = "9dc0e823-56b0-43ca-9ca3-47e25a8eb543";
CrispClient.website.saveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked, articleIdLinked);
Delete Helpdesk Locale Article Alternate [user
, plugin
]: Reference
CrispClient.website.deleteHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
CrispClient.website.deleteHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked);
Publish Helpdesk Locale Article [user
, plugin
]: Reference
CrispClient.website.publishHelpdeskLocaleArticle(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.publishHelpdeskLocaleArticle(websiteID, locale, articleId);
Unpublish Helpdesk Locale Article [user
, plugin
]: Reference
CrispClient.website.unpublishHelpdeskLocaleArticle(websiteID, locale, articleId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.unpublishHelpdeskLocaleArticle(websiteID, locale, articleId);
List Helpdesk Locale Categories [user
, plugin
]: Reference
CrispClient.website.listHelpdeskLocaleCategories(websiteID, locale, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleCategories(websiteID, locale, pageNumber);
Add Helpdesk Locale Category [user
, plugin
]: Reference
CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var name = "Chatbox";
CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name);
Check If Helpdesk Locale Category Exists [user
, plugin
]: Reference
CrispClient.website.checkHelpdeskLocaleCategoryExists(websiteID, locale, categoryId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
CrispClient.website.checkHelpdeskLocaleCategoryExists(websiteID, locale, categoryId);
Resolve Helpdesk Locale Category [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskLocaleCategory(websiteID, locale, categoryId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
CrispClient.website.resolveHelpdeskLocaleCategory(websiteID, locale, categoryId);
Save Helpdesk Locale Category [user
, plugin
]: Reference
CrispClient.website.saveHelpdeskLocaleCategory(websiteID, locale, categoryId, category)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var category = {
"name": "Chatbox",
"description": "Help on how to setup and use the Crisp chatbox.",
"color": "#377FEA",
"image": null,
"order": 1
};
CrispClient.website.saveHelpdeskLocaleCategory(websiteID, locale, categoryId, category);
Update Helpdesk Locale Category [user
, plugin
]: Reference
CrispClient.website.updateHelpdeskLocaleCategory(websiteID, locale, categoryId, category)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var category = {
"color": "#377FEA"
};
CrispClient.website.updateHelpdeskLocaleCategory(websiteID, locale, categoryId, category);
Delete Helpdesk Locale Category [user
, plugin
]: Reference
CrispClient.website.deleteHelpdeskLocaleCategory(websiteID, locale, categoryId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
CrispClient.website.deleteHelpdeskLocaleCategory(websiteID, locale, categoryId);
List Helpdesk Locale Sections [user
, plugin
]: Reference
CrispClient.website.listHelpdeskLocaleSections(websiteID, locale, categoryId, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleSections(websiteID, locale, categoryId, pageNumber);
Add Helpdesk Locale Section [user
, plugin
]: Reference
CrispClient.website.addHelpdeskLocaleSection(websiteID, locale, categoryId, name)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var name = "Integrate with our SDKs";
CrispClient.website.addHelpdeskLocaleSection(websiteID, locale, categoryId, name);
Check If Helpdesk Locale Section Exists [user
, plugin
]: Reference
CrispClient.website.checkHelpdeskLocaleSectionExists(websiteID, locale, categoryId, sectionId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
CrispClient.website.checkHelpdeskLocaleSectionExists(websiteID, locale, categoryId, sectionId);
Resolve Helpdesk Locale Section [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
CrispClient.website.resolveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId);
Save Helpdesk Locale Section [user
, plugin
]: Reference
CrispClient.website.saveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
var section = {
"name": "Integrate with our SDKs",
"order": 1
};
CrispClient.website.saveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section);
Update Helpdesk Locale Section [user
, plugin
]: Reference
CrispClient.website.updateHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
var section = {
"name": "Integrate with our SDKs",
"order": 1
};
CrispClient.website.updateHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section);
Delete Helpdesk Locale Section [user
, plugin
]: Reference
CrispClient.website.deleteHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
CrispClient.website.deleteHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId);
Map Helpdesk Locale Feedback Ratings [user
, plugin
]: Reference
CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale);
List Helpdesk Locale Feedbacks [user
, plugin
]: Reference
CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber, filterDateStart, filterDateEnd)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber);
Import External Helpdesk To Locale [user
]: Reference
CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, helpdeskUrl)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var helpdeskUrl = "https://docs.acme.com/";
CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, helpdeskUrl);
Export Helpdesk Locale Articles [user
]: Reference
CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale);
List Helpdesk Redirections [user
, plugin
]: Reference
CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber);
Add Helpdesk Redirection [user
, plugin
]: Reference
CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionPath = "/en/article/how-can-i-automatically-set-custom-user-data/";
var redirectionTarget = "/en/article/how-can-i-automatically-set-custom-user-data-1xh7pqk/";
CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget);
Check If Helpdesk Redirection Exists [user
, plugin
]: Reference
CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25";
CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId);
Resolve Helpdesk Redirection [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25";
CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId);
Delete Helpdesk Redirection [user
, plugin
]: Reference
CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25";
CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId);
Resolve Helpdesk Settings [user
, plugin
]: Reference
CrispClient.website.resolveHelpdeskSettings(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.resolveHelpdeskSettings(websiteID);
Save Helpdesk Settings [user
, plugin
]: Reference
CrispClient.website.saveHelpdeskSettings(websiteID, settings)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var settings = {
"name": "Valerian Helpdesk",
"appearance": {
"logos": {
"header": null,
"footer": null
},
"banner": null
},
"behavior": {
"frequently_read": true,
"show_category_images": true,
"show_chatbox": true,
"ask_feedback": false,
"locale_picker": false,
"refer_link": true,
"forbid_indexing": false,
"status_health_dead": true
},
"include": {
"html": null
},
"access": {
"password": null
}
};
CrispClient.website.saveHelpdeskSettings(websiteID, settings);
Resolve Helpdesk Domain [user
]: Reference
CrispClient.website.resolveHelpdeskDomain(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.resolveHelpdeskDomain(websiteID);
Request Helpdesk Domain Change [user
]: Reference
CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var basic = "valerian";
var custom = "help.valeriansaliou.name";
CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom);
Generate Helpdesk Domain Setup Flow [user
]: Reference
CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var custom = "help.valeriansaliou.name";
CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom);
Check If Website Exists [user
, plugin
]: Reference
CrispClient.website.checkWebsiteExists(domain)
CrispClient.website.checkWebsiteExists(domain);
Create Website [user
]: Reference
CrispClient.website.createWebsite(websiteData)
CrispClient.website.createWebsite(websiteData);
Get A Website [user
, plugin
]: Reference
CrispClient.website.getWebsite(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getWebsite(websiteID);
Delete A Website [user
]: Reference
CrispClient.website.deleteWebsite(websiteID, verify)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var verify = "MySuperSecurePassword";
CrispClient.website.deleteWebsite(websiteID, verify);
Get Website Settings [user
, plugin
]: Reference
CrispClient.website.getWebsiteSettings(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getWebsiteSettings(websiteID);
Update Website Settings [user
, plugin
]: Reference
CrispClient.website.updateWebsiteSettings(websiteID, settings)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var settings = {
"name": "Crisp",
"domain": "crisp.chat",
"logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
"contact": {
"email": "[email protected]",
"phone": "+33757905447"
},
"inbox": {
"lock_removal": false,
"force_operator_token": false
},
"emails": {
"rating": true,
"transcript": true,
"enrich": true,
"junk_filter": true
},
"chatbox": {
"tile": "default",
"wait_game": false,
"website_logo": true,
"last_operator_face": false,
"ongoing_operator_face": true,
"activity_metrics": true,
"operator_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,
"overlay_search": true,
"overlay_mode": false,
"helpdesk_link": true,
"helpdesk_only": false,
"status_health_dead": true,
"check_domain": false,
"color_theme": "blue",
"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);
List Website Operators [user
, plugin
]: Reference
CrispClient.website.listWebsiteOperators(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.listWebsiteOperators(websiteID);
List Last Active Website Operators [user
, plugin
]: Reference
CrispClient.website.listLastActiveWebsiteOperators(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.listLastActiveWebsiteOperators(websiteID);
Flush Last Active Website Operators [user
]: Reference
CrispClient.website.flushLastActiveWebsiteOperators(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.flushLastActiveWebsiteOperators(websiteID);
Send Email To Website Operators [user
, plugin
]: Reference
CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)
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 [user
, plugin
]: Reference
CrispClient.website.getWebsiteOperator(websiteID, userID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
CrispClient.website.getWebsiteOperator(websiteID, userID);
Invite A Website Operator [user
]: Reference
CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var verify = {
"email": "[email protected]",
"role": "member",
"verify": "MySuperSecurePassword"
};
CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
Change Operator Membership [user
]: Reference
CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)
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 [user
]: Reference
CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID);
Count Visitors [user
, plugin
]: Reference
CrispClient.website.countVisitors(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.countVisitors(websiteID);
List Visitors [user
, plugin
]: Reference
CrispClient.website.listVisitors(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listVisitors(websiteID, pageNumber);
Pinpoint Visitors On A Map [user
, plugin
]: Reference
CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius);
Get Session Identifier From Token [user
, plugin
]: Reference
CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904";
CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID);
Count Blocked Visitors [user
]: Reference
CrispClient.website.countBlockedVisitors(websiteID)
Count Blocked Visitors In Rule [user
]: Reference
CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.countBlockedVisitorsInRule(websiteID, rule);
Clear Blocked Visitors In Rule [user
]: Reference
CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule);
Get Website Availability Status [user
, plugin
]: Reference
CrispClient.website.getWebsiteAvailabilityStatus(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getWebsiteAvailabilityStatus(websiteID);
List Website Operator Availabilities [user
, plugin
]: Reference
CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.listWebsiteOperatorAvailabilities(websiteID);
Acquire Analytics Points [user
]: Reference
CrispClient.website.acquireAnalyticsPoints(websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier, filterPrimary, filterSecondary, filterTertiary)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.acquireAnalyticsPoints(websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier, filterPrimary, filterSecondary, filterTertiary);
List Analytics Filters [user
]: Reference
CrispClient.website.listAnalyticsFilters(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listAnalyticsFilters(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
List Analytics Classifiers [user
]: Reference
CrispClient.website.listAnalyticsClassifiers(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listAnalyticsClassifiers(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
Batch Resolve Conversations [user
]: Reference
CrispClient.website.batchResolveConversations(websiteID, sessions)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.batchResolveConversations(websiteID, sessions);
Batch Read Conversations [user
]: Reference
CrispClient.website.batchReadConversations(websiteID, sessions)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.batchReadConversations(websiteID, sessions);
Batch Remove Conversations [user
]: Reference
CrispClient.website.batchRemoveConversations(websiteID, sessions)
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 Remove People [user
]: Reference
CrispClient.website.batchRemovePeople(websiteID, people)
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);
Get Verify Settings [user
, plugin
]: Reference
CrispClient.website.getVerifySettings(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getVerifySettings(websiteID);
Update Verify Settings [user
, plugin
]: Reference
CrispClient.website.updateVerifySettings(websiteID, settings)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var settings = {
"enabled": true
};
CrispClient.website.updateVerifySettings(websiteID, settings);
Get Verify Key [user
, plugin
]: Reference
CrispClient.website.getVerifyKey(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getVerifyKey(websiteID);
Roll Verify Key [user
, plugin
]: Reference
CrispClient.website.rollVerifyKey(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.rollVerifyKey(websiteID);
List Campaigns [user
]: Reference
CrispClient.website.listCampaigns(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listCampaigns(websiteID, pageNumber);
List Campaign Tags [user
]: Reference
CrispClient.website.listCampaignTags(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.listCampaignTags(websiteID);
List Campaign Templates [user
, plugin
]: Reference
CrispClient.website.listCampaignTemplates(websiteID, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listCampaignTemplates(websiteID, pageNumber);
Create A New Campaign Template [user
, plugin
]: Reference
CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName)
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 [user
, plugin
]: Reference
CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
CrispClient.website.checkCampaignTemplateExists(websiteID, templateID);
Get A Campaign Template [user
, plugin
]: Reference
CrispClient.website.getCampaignTemplate(websiteID, templateID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
CrispClient.website.getCampaignTemplate(websiteID, templateID);
Save A Campaign Template [user
, plugin
]: Reference
CrispClient.website.saveCampaignTemplate(websiteID, templateID, template)
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 [user
, plugin
]: Reference
CrispClient.website.updateCampaignTemplate(websiteID, templateID, template)
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 [user
, plugin
]: Reference
CrispClient.website.removeCampaignTemplate(websiteID, templateID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
CrispClient.website.removeCampaignTemplate(websiteID, templateID);
Create A New Campaign [user
]: Reference
CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignName = {
"type": "one-shot",
"name": "Welcome!"
};
CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName);
Check If Campaign Exists [user
]: Reference
CrispClient.website.checkCampaignExists(websiteID, campaignID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
CrispClient.website.checkCampaignExists(websiteID, campaignID);
Get A Campaign [user
]: Reference
CrispClient.website.getCampaign(websiteID, campaignID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
CrispClient.website.getCampaign(websiteID, campaignID);
Save A Campaign [user
]: Reference
CrispClient.website.saveCampaign(websiteID, campaignID, campaign)
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 [user
]: Reference
CrispClient.website.updateCampaign(websiteID, campaignID, campaign)
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 [user
]: Reference
CrispClient.website.removeCampaign(websiteID, campaignID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
CrispClient.website.removeCampaign(websiteID, campaignID);
Dispatch A Campaign [user
]: Reference
CrispClient.website.dispatchCampaign(websiteID, campaignID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
CrispClient.website.dispatchCampaign(websiteID, campaignID);
Resume A Campaign [user
]: Reference
CrispClient.website.resumeCampaign(websiteID, campaignID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
CrispClient.website.resumeCampaign(websiteID, campaignID);
Pause A Campaign [user
]: Reference
CrispClient.website.pauseCampaign(websiteID, campaignID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
CrispClient.website.pauseCampaign(websiteID, campaignID);
Test A Campaign [user
]: Reference
CrispClient.website.testCampaign(websiteID, campaignID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
CrispClient.website.testCampaign(websiteID, campaignID);
List Campaign Recipients [user
]: Reference
CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber)
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 [user
]: Reference
CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
var pageNumber = 1;
CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber);
⭐ Get Connect Account [plugin
]: Reference
CrispClient.plugin.getConnectAccount()
CrispClient.plugin.getConnectAccount();
⭐ Check Connect Session Validity [plugin
]: Reference
CrispClient.plugin.checkConnectSessionValidity()
CrispClient.plugin.checkConnectSessionValidity();
⭐ List All Connect Websites [plugin
]: Reference
CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
var pageNumber = 1;
CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured);
⭐ List Connect Websites Since [plugin
]: Reference
CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)
var dateSince = "2023-08-16T09:00:00Z";
CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured);
⭐ Get Connect Endpoints [plugin
]: Reference
CrispClient.plugin.getConnectEndpoints()
CrispClient.plugin.getConnectEndpoints();
List All Active Subscriptions [user
]: Reference
CrispClient.plugin.listAllActiveSubscriptions()
CrispClient.plugin.listAllActiveSubscriptions();
List Subscriptions For A Website [user
]: Reference
CrispClient.plugin.listSubscriptionsForWebsite(websiteID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.plugin.listSubscriptionsForWebsite(websiteID);
Get Subscription Details [user
, plugin
]: Reference
CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID);
Subscribe Website To Plugin [user
]: Reference
CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)
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 [user
]: Reference
CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID);
Get Subscription Settings [user
, plugin
]: Reference
CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID);
Save Subscription Settings [user
, plugin
]: Reference
CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings)
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 [user
, plugin
]: Reference
CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings)
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 [user
, plugin
]: Reference
CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
CrispClient.plugin.getPluginUsageBills(websiteID, pluginID);
Report Plugin Usage To Bill [plugin
]: Reference
CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage)
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);
Forward Plugin Payload To Channel [user
, plugin
]: Reference
CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)
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 [user
, plugin
]: Reference
CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload)
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
var payload = {
"name": "bot-is-running",
"data": {
"bot": "Sales",
"email": "[email protected]"
}
};
CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload);
user
]: Reference
CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)
var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3";
var pageNumber = 1;
CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery);
user
, plugin
]: Reference
CrispClient.bucket.generateBucketURL(data)
CrispClient.bucket.generateBucketURL(data);
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:
Before you start with RTM events, please consider the following:
CrispClient.on()
, as the library doesn't connect to the realtime backend automatically. This method returns a Promise
object.CrispClient.rebindSocket()
. This method also returns a Promise
object. This only applies to WebSockets with the RTM API.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:
CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
CrispClient.verifyHook(secret, body, timestamp, signature)
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.
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:
CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)
Available events are listed below:
user
, plugin
]:
session:update_availability
user
, plugin
]:
session:update_verify
user
, plugin
]:
session:request:initiated
user
, plugin
]:
session:set_email
user
, plugin
]:
session:set_phone
user
, plugin
]:
session:set_address
user
, plugin
]:
session:set_subject
user
, plugin
]:
session:set_avatar
user
, plugin
]:
session:set_nickname
user
, plugin
]:
session:set_data
user
, plugin
]:
session:sync:pages
user
, plugin
]:
session:sync:events
user
, plugin
]:
session:sync:capabilities
user
, plugin
]:
session:sync:geolocation
user
, plugin
]:
session:sync:system
user
, plugin
]:
session:sync:network
user
, plugin
]:
session:sync:timezone
user
, plugin
]:
session:sync:locales
user
, plugin
]:
session:sync:rating
user
, plugin
]:
session:sync:topic
user
, plugin
]:
session:set_state
user
, plugin
]:
session:set_block
user
, plugin
]:
session:set_segments
user
, plugin
]:
session:set_opened
user
, plugin
]:
session:set_closed
user
, plugin
]:
session:set_participants
user
, plugin
]:
session:set_mentions
user
, plugin
]:
session:set_routing
user
, plugin
]:
session:removed
user
, plugin
]:
message:updated
user
, plugin
]:
message:send
user
, plugin
]:
message:received
user
, plugin
]:
message:removed
user
, plugin
]:
message:compose:send
user
, plugin
]:
message:compose:receive
user
, plugin
]:
message:acknowledge:read:send
user
, plugin
]:
message:acknowledge:read:received
user
, plugin
]:
message:acknowledge:delivered
user
, plugin
]:
message:notify:unread:send
user
, plugin
]:
message:notify:unread:received
user
, plugin
]:
people:profile:created
user
, plugin
]:
people:profile:updated
user
, plugin
]:
people:profile:removed
user
, plugin
]:
people:bind:session
user
, plugin
]:
people:sync:profile
user
]:
people:import:progress
user
]:
people:import:done
user
]:
campaign:progress
user
]:
campaign:dispatched
user
]:
campaign:running
user
, plugin
]:
browsing:request:initiated
user
, plugin
]:
browsing:request:rejected
user
, plugin
]:
call:request:initiated
user
, plugin
]:
call:request:rejected
user
]:
widget:action:processed
user
]:
status:health:changed
user
, plugin
]:
website:update_visitors_count
user
, plugin
]:
website:update_operators_availability
user
, plugin
]:
website:users:available
user
, plugin
]:
bucket:url:upload:generated
user
, plugin
]:
bucket:url:avatar:generated
user
, plugin
]:
bucket:url:website:generated
user
, plugin
]:
bucket:url:campaign:generated
user
, plugin
]:
bucket:url:helpdesk:generated
user
, plugin
]:
bucket:url:status:generated
user
, plugin
]:
bucket:url:processing:generated
user
]:
media:animation:listed
user
, plugin
]:
email:subscribe
user
, plugin
]:
email:track:view
user
, plugin
]:
plugin:channel
user
, plugin
]:
plugin:event
user
, plugin
]:
plugin:settings:saved