The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).
Canva Developers SDK
The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).

appProcess

API reference for the appProcess namespace.
This version of the API is deprecated. This version will soon be unsupported. You should use a stable version of the API in your app.

A namespace that organizes methods and properties related to app processes.

Usage

import { appProcess } from "@canva/platform";
TSX

Properties

broadcastMessagefunction
Required

Sends a message to all active app processes.

To learn more, see appProcess.broadcastMessage.

currentobject
Required

Represents the current app process.

To learn more, see appProcess.current.

registerOnMessagefunction
Required

Registers a callback that runs when an app process receives a message.

To learn more, see appProcess.registerOnMessage.

registerOnStateChangefunction
Required

Registers a callback that runs when the state of an app process changes.

To learn more, see appProcess.registerOnStateChange.

requestClosefunction
Required

Requests the termination of an app process.

To learn more, see appProcess.requestClose.