Docs / Workflows / Integrations / Crisp
Crisp
Read conversations and reply, add private notes or route work in a Crisp website.
What you can do
Each Crisp integration’s page in OAIZ shows these uses, with its events and its read and write actions, under What you can do with Crisp.
- Chat answers
- Answer website chat messages from your help articles.
- Conversation routing
- Assign each conversation to the right person by topic.
- Order history notes
- Add a private note with the customer’s order history.
Connection scope
A connection belongs to one Crisp website. Conversation IDs identify sessions, while operator IDs identify the people assigned or mentioned. A conversation keeps its own custom data and segments across workflow runs.
Connecting
Start the Crisp connection in OAIZ and install the OAIZ plugin on the Crisp website you want to connect. A website owner approves the installation.
Crisp shows the requested permissions during installation. These allow the plugin to read and reply to conversations, change their data and assignment, and read operators.
Read actions
- Get Conversation
- Read a conversation’s state, subject, email, nickname, assignment and session data.
- List Conversations
- List conversation summaries with cursor pagination.
- List Messages
- Read a conversation’s messages, starting with the newest exchange. The cursor continues toward older messages.
- Get Original Message
- Read the raw headers and body of an email-origin message.
- List Operators
- List the website’s operators with IDs, email addresses and roles.
Write actions
- Send Message
- Send an operator’s text reply through the conversation’s chat or email channel.
- Send Note
- Add an operator-only private note to a conversation, with optional operator mentions.
- Update Conversation State
- Mark a conversation resolved, unresolved or pending.
- Assign Conversation
- Assign a conversation to an operator by userId, or clear its assignment with unassign set to true.
- Set Session Data
- Merge custom JSON fields into a conversation’s saved session data.
- Set Session Segments
- Replace, add or remove a conversation’s tags.
- Start Typing
- Show an operator typing indicator in a conversation.
- Stop Typing
- Clear the operator typing indicator.
Events
Crisp conversation and message events identify the session that changed. Messages retain the channel the customer used, such as chat or email. Actions use that session identity to read context or respond.