getConversation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a conversation by conversation ID.

If you don't have the conversation ID, use getOrCreateConversation() to retrieve the conversation using the visitor, contact, or member ID.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Inbox Messages
Read Inbox Messages
Learn more about app permissions.
Method Declaration
Copy
function getConversation(conversationId: string): Promise<Conversation>;
Method Parameters
conversationIdstringRequired

Conversation ID.

Returns
Return Type:Promise<Conversation>
JavaScript
import { conversations } from "@wix/inbox";

async function getConversation(conversationId) {
  const response = await conversations.getConversation(conversationId);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?