The Crisp connector lets your AI agent act in each user's Crisp account. Each user connects their own Crisp username and password once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 50 tools.
- Tools
- 50
- What they doRead · write · destructive
- 34 · 14 · 234 read14 write2 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Crisp connection
In AgentKit > Connections, create a Crisp connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolcrisp_count_visitorsCount the visitors currently on the website.Read-onlyCount Visitors
Count the visitors currently on the website. Returns count, active (actively browsing) and limited (true when sockets are limited by high traffic). Use crisp_list_visitors to see who they are.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_generate_analyticsGenerate an analytics report for a metric and type over a date range, such as conversation totals or response time.Read-onlyGenerate Analytics
Generate an analytics report for a metric and type over a date range, such as conversation totals or response time. Returns the computed series in the data object for the requested split. This only reads data. Requires a Crisp plan with analytics access.
Inputs
dateobjectrequired- Date range. Object with from and to as ISO 8601 date-times, split (all, hourly, daily, weekly, monthly or yearly) and timezone as an IANA name. Example: {"from": "2026-01-01T00:00:00.000Z", "to": "2026-02-01T00:00:00.000Z", "split": "daily", "timezone": "Europe/Paris"}.
metricstringrequired- Metric to analyze. Example: conversation for conversation counts, message for message volume, people_created for new contacts.one of
conversationconversation_assignedconversation_shortcutconversation_segmentconversation_statehelpdesk_readhelpdesk_searchvisitor_visitvisitor_triggercampaign_activitycampaign_sentpeople_createdstatus_downtimemessage typestringrequired- Kind of analysis for the metric. Valid values depend on the metric; total works for most, while response_time and resolution_time fit conversation metrics.one of
totaluniqueresponse_timeresolution_timehandle_timemessagesvisitor_messagesoperator_messagesratingoperator website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
aggregatorstring- How values are aggregated over the period.one of
averagemoving_averagemedianminimummaximumsum filterobject- Filter options, which depend on the metric. Example: {"inbox_id": "f4e5d6c7-b8a9-4012-8345-6789abcdef01"}.
raw_exportboolean- When true, return the data in raw format.
split_bystring- Key to split results by.
crisp_get_availability_statusCheck whether the website chatbox currently shows as online, away or offline to visitors.Read-onlyGet Website Availability Status
Check whether the website chatbox currently shows as online, away or offline to visitors. Returns status (online, away or offline) and since, the timestamp of the last status change. Use crisp_list_operator_availabilities to see availability per operator instead.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_conversationRetrieve one conversation by session id.Read-onlyGet Conversation
Retrieve one conversation by session id. Returns session_id, state, inbox_id, people_id, availability, last_message, unread counts, participants, mentions and created and updated timestamps. Use crisp_list_messages to read the messages themselves. Use crisp_get_conversation_meta for visitor details.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_conversation_metaRetrieve the visitor details attached to a conversation.Read-onlyGet Conversation Meta
Retrieve the visitor details attached to a conversation. Returns nickname, email, phone, address, subject, origin, ip, data, segments and device information. Use crisp_get_people_profile for the saved CRM profile instead.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_conversation_participantsRetrieve the external participants of a conversation, such as email addresses in CC.Read-onlyGet Conversation Participants
Retrieve the external participants of a conversation, such as email addresses in CC. Returns a participants array of objects with type and target. Use crisp_get_conversation for general conversation details.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_conversation_routingRetrieve the operator a conversation is currently assigned to.Read-onlyGet Conversation Routing
Retrieve the operator a conversation is currently assigned to. Returns assigned.user_id inside the data object, or an empty assignment when unassigned. Use crisp_assign_conversation_routing to assign or unassign.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_conversation_stateRetrieve the state of a conversation: pending, unresolved or resolved.Read-onlyGet Conversation State
Retrieve the state of a conversation: pending, unresolved or resolved. Returns state inside the data object. Use crisp_update_conversation_state to change it.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_helpdeskRetrieve the helpdesk (knowledge base) name and public URL for the website.Read-onlyGet Helpdesk
Retrieve the helpdesk (knowledge base) name and public URL for the website. Returns name and url. Use crisp_list_helpdesk_locales to see which languages exist.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_helpdesk_page_entityResolve one published helpdesk page by entity id.Read-onlyGet Helpdesk Page
Resolve one published helpdesk page by entity id. Returns entity_id, title, tree_path and public url. Use crisp_list_helpdesk_pages to find entity ids.
Inputs
entity_idstringrequired- Content entity identifier from crisp_list_helpdesk_pages. Example: 9f8e7d6c-5b4a-4321-8fed-cba987654321.
localestringrequired- Helpdesk locale code, as returned in locale by crisp_list_helpdesk_locales. Example: en.
typestringrequired- Helpdesk content type: articles, guides, references or news.one of
articlesguidesreferencesnews website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_inboxRetrieve one inbox by id.Read-onlyGet Inbox
Retrieve one inbox by id. Returns inbox_id, name, emoji, order, member operators and teams. Use crisp_list_inboxes to find inbox ids.
Inputs
inbox_idstringrequired- Inbox identifier from crisp_list_inboxes. Example: f4e5d6c7-b8a9-4012-8345-6789abcdef01.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_messageRetrieve a single message in a conversation by its fingerprint.Read-onlyGet Conversation Message
Retrieve a single message in a conversation by its fingerprint. Returns the message with type, from, origin, content, fingerprint, timestamp and user. Use crisp_list_messages to find fingerprints.
Inputs
fingerprintnumberrequired- Unique numeric fingerprint of the message, as returned in fingerprint by crisp_list_messages. Example: 1767225600123.
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_operatorRetrieve one website operator by user id.Read-onlyGet Operator
Retrieve one website operator by user id. Returns user_id, email, avatar, first_name, last_name, role, title and availability. Use crisp_list_operators to find user ids.
Inputs
user_idstringrequired- User identifier of the operator, from crisp_list_operators. Example: 7d2f1c3e-5a6b-4c8d-9e0f-1a2b3c4d5e6f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_people_dataRetrieve the custom key-value data stored on a contact.Read-onlyGet People Data
Retrieve the custom key-value data stored on a contact. Returns the stored data object, which may be empty. Use crisp_update_people_data to change it.
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_people_profileRetrieve one contact profile by people id or email address.Read-onlyGet People Profile
Retrieve one contact profile by people id or email address. Returns people_id, email, person, company, employment, segments, notepad and timestamps. Use crisp_list_people_profiles to search when you do not have an id.
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_people_statsCount the contacts stored in the website CRM.Read-onlyGet People Statistics
Count the contacts stored in the website CRM. Returns total, the number of people profiles. Use crisp_list_people_profiles to browse the profiles.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_people_subscriptionCheck whether a contact is subscribed to emails.Read-onlyGet People Subscription
Check whether a contact is subscribed to emails. Returns email, true when subscribed. Use crisp_update_people_subscription to change it.
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_teamRetrieve one operator team by id.Read-onlyGet Team
Retrieve one operator team by id. Returns team_id, name, emoji, the user ids of its operators and timestamps. Use crisp_list_teams to find team ids.
Inputs
team_idstringrequired- Team identifier from crisp_list_teams. Example: a1b2c3d4-e5f6-4789-8abc-def012345678.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_websiteRetrieve the name, domain, logo and verification status of a Crisp website (workspace).Read-onlyGet Website
Retrieve the name, domain, logo and verification status of a Crisp website (workspace). Returns website_id, name, domain, logo, verified and institutional inside the data object. Use crisp_get_website for basic identity. Use crisp_get_website_settings for the full configuration.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_get_website_settingsRetrieve the current configuration of a Crisp website, including chatbox, email, contact form and auditing settings.Read-onlyGet Website Settings
Retrieve the current configuration of a Crisp website, including chatbox, email, contact form and auditing settings. Returns the data object with website_id, name, domain, alternate domains, logo and the nested settings groups. Use crisp_get_website for just the name and domain. Use this tool when you need configuration details.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_list_conversation_eventsList the stacked events recorded in a conversation, such as page visits and custom events.Read-onlyList Conversation Events
List the stacked events recorded in a conversation, such as page visits and custom events. Returns events with text, data, color and timestamp. Use crisp_list_people_events for events stored on the contact profile.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of events to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_conversation_filesList the files shared in a conversation, extracted from its messages.Read-onlyList Conversation Files
List the files shared in a conversation, extracted from its messages. Returns each file's name, MIME type, url, fingerprint and timestamp. Use crisp_list_messages when you need the surrounding messages.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of files to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_conversationsList conversations in a Crisp website, optionally filtered by search text, inbox, state, assignment or date range.Read-onlyList Conversations
List conversations in a Crisp website, optionally filtered by search text, inbox, state, assignment or date range. Returns one page of conversations with session_id, state, people_id, inbox_id, last_message, unread counts and timestamps. Use crisp_get_conversation for the full detail of a single conversation. Use crisp_list_people_conversations for one contact's conversations.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
filter_assignedstring- Only return conversations assigned to this operator user_id (from crisp_list_operators).
filter_date_endstring- Only return conversations updated on or before this ISO 8601 date-time. Example: 2026-02-01T00:00:00.000Z.
filter_date_startstring- Only return conversations updated on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00.000Z.
filter_inbox_idstring- Only return conversations in this inbox. Use the inbox_id from crisp_list_inboxes, or the word all for every inbox.
filter_mentionstring- Only return conversations where the authenticated user is mentioned. Use 1 to enable or 0 to disable.one of
01 filter_not_resolvedstring- Only return conversations that are not resolved. Use 1 to enable or 0 to disable.one of
01 filter_resolvedstring- Only return resolved conversations. Use 1 to enable or 0 to disable.one of
01 filter_scheduledstring- Only return conversations that contain scheduled messages created by the authenticated user. Use 1 to enable or 0 to disable.one of
01 filter_unassignedstring- Only return conversations not assigned to any operator. Use 1 to enable or 0 to disable.one of
01 filter_unreadstring- Only return conversations with unread messages. Use 1 to enable or 0 to disable.one of
01 include_emptystring- Include conversations that contain no message. Use 1 to enable or 0 to disable.one of
01 order_date_createdstring- Order conversations by creation date instead of the default order. Use 1 to enable or 0 to disable.one of
01 order_date_updatedstring- Order conversations by last update date instead of the default order. Use 1 to enable or 0 to disable.one of
01 order_date_waitingstring- Order conversations by longest waiting time; this also drops conversations that are not waiting for a reply. Use 1 to enable or 0 to disable.one of
01 page_numberstring- Page number of conversations to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1 per_pagestring- Number of conversations per page, between 20 and 50. Crisp defaults to 20.
search_operatorstring- Boolean operator combining filters when search_type is filter. Crisp defaults to and.one of
andor search_querystring- Text to search for in all conversations. Used together with search_type. Example: refund request.
search_typestring- How to interpret search_query: text for a text search, segment to match a segment name, or filter for a filter expression.one of
textsegmentfilter
crisp_list_helpdesk_localesList the locales (languages) configured for the website helpdesk.Read-onlyList Helpdesk Locales
List the locales (languages) configured for the website helpdesk. Returns locales with locale_id, locale code, public url and content statistics per type. Use the locale code with crisp_list_helpdesk_pages.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of helpdesk locales to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_helpdesk_pagesList published helpdesk pages for a locale and content type.Read-onlyList Helpdesk Pages
List published helpdesk pages for a locale and content type. Returns pages with entity_id, title, tree_path and public url. Use crisp_get_helpdesk_page_entity to resolve one page by entity id.
Inputs
localestringrequired- Helpdesk locale code, as returned in locale by crisp_list_helpdesk_locales. Example: en.
typestringrequired- Helpdesk content type: articles, guides, references or news.one of
articlesguidesreferencesnews website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of helpdesk pages to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_inboxesList the inboxes of the website.Read-onlyList Inboxes
List the inboxes of the website. Returns inboxes with inbox_id, name, emoji, order, member operators and teams. Use crisp_get_inbox for one inbox. Inboxes may require a paid Crisp plan.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of inboxes to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_messagesList the messages of a conversation, newest batch first.Read-onlyList Conversation Messages
List the messages of a conversation, newest batch first. Returns an array of messages with type, from, origin, content, fingerprint, timestamp and user. Page backward with timestamp_before, forward with timestamp_after, or jump with timestamp_around. Use crisp_get_message for a single message by fingerprint.
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
timestamp_afterstring- Return the batch of messages that starts after this timestamp in milliseconds, to page toward newer messages.
timestamp_aroundstring- Return a batch of messages centered on this timestamp in milliseconds, to jump to a specific message.
timestamp_beforestring- Return the batch of messages that ends before this timestamp in milliseconds. Use the oldest timestamp you already have to page toward older messages.
crisp_list_operator_availabilitiesList the current availability of every operator on the website.Read-onlyList Operator Availabilities
List the current availability of every operator on the website. Returns one entry per operator with user_id, type (online, away or offline) and since timestamp. Use crisp_get_availability_status for the website-wide status. Use crisp_list_operators for operator profiles.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_list_operatorsList all operators who are members of the website.Read-onlyList Operators
List all operators who are members of the website. Returns members with type (operator, invite or sandbox) and details such as user_id, email, first_name, last_name, role and title. Use crisp_get_operator for one operator by user id.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_list_people_conversationsList the conversations linked to one contact.Read-onlyList People Conversations
List the conversations linked to one contact. Returns an array of conversation session ids. Use crisp_get_conversation on each id for details, or crisp_list_conversations to search all conversations.
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
filter_not_resolvedstring- Only return conversations that are not resolved. Use 1 to enable or 0 to disable.one of
01 filter_resolvedstring- Only return resolved conversations. Use 1 to enable or 0 to disable.one of
01 filter_unreadstring- Only return conversations with unread messages. Use 1 to enable or 0 to disable.one of
01 page_numberstring- Page number of the contact's conversations to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_people_eventsList the events recorded on a contact's timeline.Read-onlyList People Events
List the events recorded on a contact's timeline. Returns events with text, data, color and timestamp. Use crisp_add_people_event to record a new one.
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of events to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_people_profilesList contact profiles in the website CRM, optionally searched, sorted or limited by creation date.Read-onlyList People Profiles
List contact profiles in the website CRM, optionally searched, sorted or limited by creation date. Returns one page of profiles with people_id, email, person, company, segments and timestamps. Use crisp_get_people_profile for a single contact by id or email.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
filter_date_endstring- Only return profiles created on or before this ISO 8601 date-time.
filter_date_startstring- Only return profiles created on or after this ISO 8601 date-time.
page_numberstring- Page number of people profiles to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1 per_pagestring- Number of profiles per page, between 20 and 50. Crisp defaults to 20.
search_filterstring- Structured filter, passed as a JSON-encoded string, in the format of Crisp's people search filters.
search_operatorstring- Boolean operator combining search_filter conditions: and or or. Crisp defaults to and.one of
andor search_textstring- Free text for a quick search over profiles. Example: jane@example.com.
sort_fieldstring- Profile field to sort on, such as nickname or email.
sort_orderstring- Sort direction: ascending or descending.one of
ascendingdescending
crisp_list_teamsList the operator teams of the website.Read-onlyList Teams
List the operator teams of the website. Returns teams with team_id, name, emoji, operators and timestamps. Use crisp_get_team for a single team.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of teams to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_list_visitorsList the visitors currently on the website.Read-onlyList Visitors
List the visitors currently on the website. Returns visitors with session_id, nickname, email, avatar, useragent and location. Use crisp_count_visitors for a total only.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
page_numberstring- Page number of visitors to return, starting at 1. Defaults to 1. Increase it to read further pages until a page comes back empty.default
1
crisp_add_people_eventRecord an event on a contact's timeline, for example a purchase or signup.WriteAdd People Event
Record an event on a contact's timeline, for example a purchase or signup. Returns an empty data object on success. Use crisp_list_people_events to read the timeline back.
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
textstringrequired- Short description of the event. Example: Upgraded to Pro plan.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
colorstring- Color label for the event in the Crisp UI.one of
redorangeyellowgreenbluepurplepinkbrowngreyblack dataobject- Extra key-value data for the event. Example: {"plan": "pro"}.
crisp_assign_conversation_routingAssign a conversation to an operator, or unassign it.WriteAssign Conversation Routing
Assign a conversation to an operator, or unassign it. Returns an empty data object on success. Get operator ids from crisp_list_operators. Pass an empty assigned object to unassign.
- Idempotent
Inputs
assignedobjectrequired- Operator to assign, as an object with user_id. Example: {"user_id": "7d2f1c3e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"}. Pass an empty object {} to remove the assignment.
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
silentboolean- When true, the assigned operator is not notified.
crisp_create_conversationCreate a new empty conversation in a Crisp website.WriteCreate Conversation
Create a new empty conversation in a Crisp website. Returns the new session_id inside the data object. The conversation stays hidden from the Crisp inbox until a message with from set to user is sent, so follow with crisp_send_message.
Inputs
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_create_people_profileCreate a new contact profile in the website CRM.WriteCreate People Profile
Create a new contact profile in the website CRM. Returns the new people_id inside the data object. Fails with a conflict when the email already exists; use crisp_update_people_profile to change an existing contact.
Inputs
emailstringrequired- Email address of the contact. Must be unique in the website. Example: jane@example.com.
personobjectrequired- Personal details of the contact. It must include nickname, the full name, and may also include avatar, gender (male or female), phone, address, description, website, timezone as a UTC offset number, employment details such as title and role, and a locales list. Example: {"nickname": "Jane Doe", "phone": "+14155550123"}.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
activenumber- Timestamp in milliseconds at which the contact was last active.
companyobject- Company details for the contact, which must include name when set and may include domain, url, description, phones, emails and employee metrics. Example: {"name": "Acme Inc", "domain": "acme.com"}.
notepadstring- Private operator notes stored on the profile.
segmentsarray- Segment names to attach to the profile. Example: ["customer", "vip"].
crisp_mark_conversation_unreadMark a whole conversation as unread.WriteMark Conversation Unread
Mark a whole conversation as unread. Returns the accepted status. Use crisp_mark_messages_read to mark messages read again.
- Idempotent
Inputs
fromstringrequired- Sender direction to mark unread. Crisp only accepts user, meaning the visitor's messages become unread for operators.one of
user session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_mark_messages_readMark messages in a conversation as read, either specific messages or all of them.WriteMark Messages Read
Mark messages in a conversation as read, either specific messages or all of them. Returns the accepted status. Set from to user to mark the visitor's messages read by operators. Use crisp_mark_conversation_unread to reverse it.
- Idempotent
Inputs
fromstringrequired- Direction of the messages being marked: user marks the visitor's messages as read by the team, operator marks the team's messages as read by the visitor.one of
useroperator originstringrequired- Channel of the read receipt: chat, email or a urn: value. Match the conversation's origin.
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
fingerprintsarray- Message fingerprints to mark as read. When omitted, every message in the conversation is marked read. Example: [1767225600123].
crisp_send_messageSend a message into an existing conversation as the operator or on behalf of the visitor.WriteSend Conversation Message
Send a message into an existing conversation as the operator or on behalf of the visitor. Returns the message fingerprint inside the data object once the message is accepted. Use type note with from operator for a private internal note. Use crisp_create_conversation first when no conversation exists.
Inputs
contentstringrequired- Message body. For type text or note this is a plain string, for example Thanks for reaching out. For file, animation or audio it is an object with url, type and name (plus duration for audio). For picker, field, carousel and event it is an object as described in the Crisp REST API reference.
fromstringrequired- Who the message comes from: operator for a reply from the team, or user for the visitor.one of
useroperator originstringrequired- Channel the message belongs to: chat for the Crisp chatbox, email for email, or a urn: value for a custom integration. Match the conversation's origin.
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
typestringrequired- Kind of message. Use text for a normal message, note for a private operator note, or file, animation, audio, picker, field, carousel or event for rich content.one of
textnotefileanimationaudiopickerfieldcarouselevent website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
automatedboolean- Mark the message as automated, meaning it comes from a bot.
fingerprintnumber- Client-chosen unique numeric fingerprint, useful to deduplicate messages. Crisp generates one when omitted.
mentionsarray- User or team identifiers to mention in the message. Mainly used with notes.
originalobject- Original message data to keep, with type (text/plain or text/html) and content. Example: {"type": "text/plain", "content": "Hello"}.
propertiesobject- Arbitrary key-value properties stored on the message.
referencesarray- Extra context for the message. Each item has type (link), name and target URL. Example: [{"type": "link", "name": "Docs", "target": "https://example.com/docs"}].
stealthboolean- When true the message is stored but not propagated to the other party.
timestampnumber- Send time in milliseconds when it should differ from now, for example to import older messages.
translatedboolean- Mark the message as auto-translated.
userobject- Display identity for the sender, with optional keys type (website or participant), nickname and avatar. Example: {"nickname": "Support Bot"}.
crisp_update_conversation_inboxMove a conversation to a different inbox, or remove it from its inbox.WriteUpdate Conversation Inbox
Move a conversation to a different inbox, or remove it from its inbox. Returns an empty data object on success. Get inbox ids from crisp_list_inboxes. Inboxes may require a paid Crisp plan.
- Idempotent
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
inbox_idstring- Inbox identifier to move the conversation into, from crisp_list_inboxes. Leave empty to remove the conversation from its inbox.
crisp_update_conversation_metaUpdate the visitor details attached to a conversation, such as nickname, email, phone, subject, custom data and segments.WriteUpdate Conversation Meta
Update the visitor details attached to a conversation, such as nickname, email, phone, subject, custom data and segments. Returns an empty data object on success. Only the fields you pass are changed. Use crisp_update_people_profile to change the CRM profile.
- Idempotent
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
addressstring- Visitor postal address.
avatarstring- URL of the visitor avatar image.
dataobject- Custom key-value data attached to the visitor. Example: {"plan": "pro"}.
emailstring- Visitor email address. Example: jane@example.com.
ipstring- Visitor IP address.
nicknamestring- Visitor nickname. Example: Jane Doe.
originstring- Conversation origin: chat, email or a urn: value.
phonestring- Visitor phone number. Example: +14155550123.
segmentsarray- Segment names to assign to the conversation. Example: ["vip", "billing"].
subjectstring- Subject line for the conversation. Example: Billing question.
crisp_update_conversation_stateChange a conversation's state to pending, unresolved or resolved.WriteUpdate Conversation State
Change a conversation's state to pending, unresolved or resolved. Returns an empty data object on success. Use resolved to close a conversation and unresolved to reopen it. Use crisp_get_conversation_state to read the current value.
- Idempotent
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
statestringrequired- New conversation state: pending (new, not yet handled), unresolved (open) or resolved (closed).one of
pendingunresolvedresolved website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_update_messageEdit the content of an existing message in a conversation.WriteUpdate Conversation Message
Edit the content of an existing message in a conversation. Returns the accepted status; the updated message is delivered asynchronously over Crisp's real-time channel. Only works for conversations started from the Crisp chatbox, not email or other channels. Find the fingerprint with crisp_list_messages.
- Idempotent
Inputs
contentstringrequired- New message content. A plain string for text and note messages, or an object for file, animation, audio, picker, field and carousel messages. Example: Updated reply text.
fingerprintnumberrequired- Fingerprint of the message to edit, from crisp_list_messages. Example: 1767225600123.
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_update_people_dataMerge new keys into the custom data stored on a contact, keeping existing keys.WriteUpdate People Data
Merge new keys into the custom data stored on a contact, keeping existing keys. Returns an empty data object on success. Use crisp_get_people_data to read the current values.
- Idempotent
Inputs
dataobjectrequired- Key-value pairs to merge into the contact's data. Keys you omit are kept. Example: {"plan": "pro", "seats": "5"}.
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_update_people_profileUpdate fields on an existing contact profile; only the fields you pass change.WriteUpdate People Profile
Update fields on an existing contact profile; only the fields you pass change. Returns an empty data object on success. Use crisp_create_people_profile for a new contact. Use crisp_update_people_data for custom key-value data.
- Idempotent
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
activenumber- Timestamp in milliseconds at which the contact was last active.
companyobject- Company details to change, any of name, legal_name, domain, url, description, phones, emails and metrics. Example: {"name": "Acme Inc"}.
emailstring- New email address for the contact. Example: jane@example.com.
notepadstring- Private operator notes stored on the profile.
personobject- Personal details to change, any of nickname, avatar, gender (male or female), phone, address, description, website, timezone, employment details and locales. Example: {"nickname": "Jane Doe"}.
segmentsarray- Segment names for the profile. This sets the list, so include every segment to keep. Example: ["customer"].
crisp_update_people_subscriptionSubscribe or unsubscribe a contact from emails.WriteUpdate People Subscription
Subscribe or unsubscribe a contact from emails. Returns an empty data object on success. Use crisp_get_people_subscription to read the current status.
- Idempotent
Inputs
emailbooleanrequired- True to subscribe the contact to emails, false to unsubscribe them.
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_delete_conversationPermanently remove a conversation and its messages from a Crisp website.DestructiveDelete Conversation
Permanently remove a conversation and its messages from a Crisp website. Returns an empty data object on success. This cannot be undone. To close a conversation without deleting it, use crisp_update_conversation_state with resolved.
- Idempotent
Inputs
session_idstringrequired- Session identifier of the conversation, as returned in session_id by crisp_list_conversations or crisp_create_conversation. Example: session_6c1d8b2a-3f4e-4a5b-9c7d-1e2f3a4b5c6d.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
crisp_delete_people_profilePermanently remove a contact profile from the website CRM.DestructiveDelete People Profile
Permanently remove a contact profile from the website CRM. Returns an empty data object on success. This cannot be undone. Use crisp_update_people_profile to edit a contact instead.
- Idempotent
Inputs
people_idstringrequired- People profile identifier from crisp_list_people_profiles or crisp_get_conversation (people_id). Crisp also accepts the contact's email address in place of the identifier. Example: 3b6f2a10-7c9d-4e1a-8f55-0a1b2c3d4e5f.
website_idstringrequired- Identifier of the Crisp website (workspace) to act on. Find it in the Crisp app under Settings > Workspace Settings > Setup Instructions, or call crisp_get_website on a known id. Example: 8c042840-1ecb-4cd5-a6a1-b3ac4a3ad8d6.
No tools match.
