Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
    • Data & Analytics
      • Anonymize a conversation or visitor data
      • Create a custom dashboard
      • Find contact data using GraphQL
      • Retrieve conversations data
      • Retrieve messages exchanged within a conversation
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (deprecated)
      • Statistic (deprecated)
      • Group (deprecated)
      • Call meeting (deprecated)
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Fourme (latest)
        • Epoisses
        • Dauphin
        • Cantal
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • CONVERSATION_ADDED
  • CONVERSATION_FOCUSED
  • CONVERSATION_FOCUS_LOST
  • CONVERSATION_STATE_BOX_CLICKED
  • CONVERSATION_VISITOR_UPDATED
  • CONVERSATION_REMOVED
  • AVAILABILITY_UPDATED
  • CONVERSATION_MESSAGE_ADDED

Was this helpful?

  1. Technologies
  2. Desk events

Reference

Event
Description

A new conversation pops in the operator's desk or the desk is refreshed with a previously opened conversation.

The conversation gets the focus because:

- It’s the only one on the iAdvize desk

- The operator clicks on it

- Another conversation is removed from the desk and this conversation is "elected" to receive the focus

The operator clicks on another conversation or the operator closes, snoozes or transfers the conversation.

The conversation disappears from the desk because the conversation is closed, snoozed, or transferred.

Triggered each time iAdvize discovers new information about the visitor:

- When the conversation is added to the iAdvize desk

- When the visitor authenticates (even during a conversation)

- When the operator edits the visitor's information from the console

- etc.

Triggered each time the agent’s status is updated for all channels available.

The different availability status are:

AVAILABLE: the agent is connected and available on this channel

UNAVAILABLE: the agent is unavailable on this channel (either disconnected or the channel is disabled by an admin)

UNAVAILABLE_FORCED: the agent is available but can’t take new conversations on this channel. This status is possible only for the call and video channels. This way, the agent can avoid taking conversations on those two channels when the agent already has a conversation in progress on the chat channel (non-parallelizable channels).

Triggered each time a visitor, an operator or an ibbü expert send a message in any conversations present on the desk conversationParticipantType must have different value: Visitor : Message is come from Visitor Professional : Message is come from operator's desk (not ibbü expert) Expert : Message is come from ibbü expert

CONVERSATION_ADDED

{ 
  "event": "com.iadvize.desk.CONVERSATION_ADDED",
  "conversationId": "c1750366-9483-4372-a57d-844da14071c6", 
  "projectId": 1234 
}

CONVERSATION_FOCUSED

{ 
  "event": "com.iadvize.desk.CONVERSATION_FOCUSED", 
  "conversationId": "c1750366-9483-4372-a57d-844da14071c6" 
}

CONVERSATION_FOCUS_LOST

{ 
  "event": "com.iadvize.desk.CONVERSATION_FOCUS_LOST", 
  "conversationId": "c1750366-9483-4372-a57d-844da14071c6" 
}

CONVERSATION_STATE_BOX_CLICKED

{ 
  "event": "com.iadvize.desk.CONVERSATION_STATE_BOX_CLICKED", 
  "conversationId": "93d86726-aaf7-4962-877e-104c577d86ae" 
}

CONVERSATION_VISITOR_UPDATED

{ 
  "event": "com.iadvize.desk.CONVERSATION_VISITOR_UPDATED", 
  "conversationId": "c1750366-9483-4372-a57d-844da14071c6", 
  "visitor": { 
    ...allKnownIAdvizeFields 
  } 
} 

CONVERSATION_REMOVED

{ 
  "event": "com.iadvize.desk.CONVERSATION_REMOVED", 
  "conversationId": "c1750366-9483-4372-a57d-844da14071c6" 
}

AVAILABILITY_UPDATED

{
  "event": "com.iadvize.desk.AVAILABILITY_UPDATED",
  "availabilities": [
    {
      "channel": "CHAT",
      "status": "AVAILABLE"
    },
    {
      "channel": "CALL",
      "status": "UNAVAILABLE"
    },
    {
      "channel": "VIDEO",
      "status": "UNAVAILABLE_FORCED"
    },
    {
      "channel": "THIRD_PARTY",
      "status": "UNAVAILABLE_FORCED"
    }
  ]
}

CONVERSATION_MESSAGE_ADDED

{
    "event": "com.iadvize.desk.CONVERSATION_MESSAGE_ADDED",
    "conversationId": "c1750366-9483-4372-a57d-844da14071c6",
    "messageId": "93d86726-aaf7-4962-877e-104c577d86ae",
    "projectId": 1234,
    "conversationParticipantType": "Professional"
}
PreviousDesk eventsNextWeb & Mobile SDK

Last updated 11 months ago

Was this helpful?

Triggered each time the operator clicks on a state box (=“conversation tab” on the left)

The allKnownIAdvizeFields refers to the visitor fields available in an .

iAdvize visitor profile
CONVERSATION_ADDED
CONVERSATION_FOCUSED
CONVERSATION_FOCUS_LOST
CONVERSATION_STATE_BOX_CLICKED
CONVERSATION_REMOVED
CONVERSATION_VISITOR_UPDATED
AVAILABILITY_UPDATED
CONVERSATION_MESSAGE_ADDED