Join Channel
channel_joinJoin a plugin channel to establish a live connection to a Figma document, enabling real-time design edits and updates.
Instructions
Join a plugin channel to establish the live connection to the Figma document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | The name of the channel to join |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Connection status | |
| channel | Yes | Channel name | |
| errorCode | No | Error code if status is error | |
| errorMessage | No | Error message if status is error | |
| readOnly | No | Whether the connection is read-only | |
| scopeRootId | No | Editable scope root node ID | |
| documentId | No | Figma document ID | |
| documentName | No | Figma document name |