Open

API Reference

App

Open Beeper Desktop app

client.app.open(?, ?): AppOpenResponse

post/v0/open-app

Open Beeper Desktop and optionally navigate to a specific chat, message, or pre-fill draft text

ParametersExpand Collapse

body: AppOpenParams

chatID?: string

Optional Beeper chat ID (or local chat ID) to focus after opening the app. If omitted, only opens/focuses the app.

draftText?: string

Optional draft text to populate in the message input field.

messageSortKey?: string

Optional message sort key. Jumps to that message in the chat when opening.

ReturnsExpand Collapse

AppOpenResponse { success }

Response indicating successful app opening.

success: boolean

Whether the app was successfully opened/focused.

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: 'My Access Token',
});

const response = await client.app.open();

console.log(response.success);

{
  "success": true
}

Returns Examples

{
  "success": true
}