API

Every vestaboard.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Subscriptions

subscriptions.list List Vestaboard subscriptions accessible with the current API key and secret Risk: read

await corsair.vestaboard.api.subscriptions.list({});

Input: empty object Output

Name	Type	Required	Description
`subscriptions`	`object[]`	Yes	—

subscriptions full type

{
  id: string,
  boardId: string
}[]

subscriptions.postMessage Send text or a 6x22 character grid to a Vestaboard subscription Risk: write

await corsair.vestaboard.api.subscriptions.postMessage({});

Input

Name	Type	Required	Description
`subscriptionId`	`string`	Yes	—
`text`	`string`	No	—
`characters`	`number[][]`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`text`	`string`	Yes	—
`created`	`string`	Yes	—
`muted`	`boolean`	Yes	—