Endpoints

The subscription API will soon be deprecated. We recommend migrating to the Read/Write API.

List all Subscriptions

This endpoint lists all Subscriptions to which the Viewer authenticated via the API key and secret has access.

Path

https://subscriptions.vestaboard.com/subscriptions

Method

GET

Headers

• x-vestaboard-api-key
• x-vestaboard-api-secret

Example Request

CURL

curl \
     -H "x-vestaboard-api-key: YOUR_KEY" \
     -H "x-vestaboard-api-secret: YOUR_SECRET" \
     https://subscriptions.vestaboard.com/subscriptions

Javascript

await fetch("https://subscriptions.vestaboard.com/subscriptions", {
  headers: {
    "Content-Type": "application/json",
    "x-vestaboard-api-key": "YOUR_KEY",
    "x-vestaboard-api-secret": "YOUR_SECRET",
  },
  method: "GET",
}).then((res) => res.json());

Example Response

[
  {
    "id": "e599aa61-8e3d-4f90-a5f1-826983a3d67a",
    "boardId": "46c06290-7961-49e0-a6fd-7874bb40a0de"
  }
]

Send Message

This endpoint allows for creation of a new Message to a Subscription for which the Viewer has access.

Path

https://subscriptions.vestaboard.com/subscriptions/{SUBSCRIPTION_ID}/message

Method

POST

Headers

• x-vestaboard-api-key
• x-vestaboard-api-secret
• Content-Type: application/json

Body

All requests must either contain unformatted text or formatted characters

• text
  • A string to be formatted and sent to the subscriptions
• characters
  • An array of arrays that is already formatted using the Vestaboard character codes

Example Request

CURL

curl \
     -X POST \
     -H "x-vestaboard-api-key: YOUR_KEY" \
     -H "x-vestaboard-api-secret: YOUR_SECRET" \
     -H "Content-Type: application/json" \
     -d '{"text": "Hello World"}' \
     https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message

CURL Windows

curl \
     -X POST \
     -H "x-vestaboard-api-key: YOUR_KEY" \
     -H "x-vestaboard-api-secret: YOUR_SECRET" \
     -H "Content-Type: application/json" \
     -d "{\"text\": \"Hello World\"}" \
     https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message

Javascript

await fetch(
  "https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message",
  {
    headers: {
      "Content-Type": "application/json",
      "x-vestaboard-api-key": "YOUR_KEY",
      "x-vestaboard-api-secret": "YOUR_SECRET",
    },
    method: "POST",
    body: JSON.stringify({ text: "Hello World" }),
  }
).then((res) => res.json());

Example Request with Character Codes

CURL

curl \
     -X POST \
     -H "x-vestaboard-api-key: YOUR_KEY" \
     -H "x-vestaboard-api-secret: YOUR_SECRET" \
     -H "Content-Type: application/json" \
     -d '{"characters": [[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]}' \
     https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message

CURL Windows

curl \
     -X POST \
     -H "x-vestaboard-api-key: YOUR_KEY" \
     -H "x-vestaboard-api-secret: YOUR_SECRET" \
     -H "Content-Type: application/json" \
     -d "{\"characters\": [[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]}" \
     https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message

Javascript

await fetch(
  "https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message",
  {
    headers: {
      "Content-Type": "application/json",
      "x-vestaboard-api-key": "YOUR_KEY",
      "x-vestaboard-api-secret": "YOUR_SECRET",
    },
    method: "POST",
    body: JSON.stringify({
      characters: [
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
      ],
    }),
  }
).then((res) => res.json());

Example Response

{
  "id": "1125e36d-4e3a-40fb-a87b-1aa90f0997a1",
  "text": "Test",
  "created": "1577839720478",
  "muted": false
}

Format Message

This endpoint takes a string and formats it into an array of arrays with Vestaboard character codes.

Path

https://vbml.vestaboard.com/format

Method

POST

Body

• message

  • A string you want to format

Example Request

CURL

curl \
     -X POST \
     -d '{"message": "Hello World"}' \
     -H "Content-Type: application/json" \
     https://vbml.vestaboard.com/format

CURL Windows

curl \
     -X POST \
     -d "{\"message\": \"Hello World\"}" \
     -H "Content-Type: application/json" \
     https://vbml.vestaboard.com/format

Javascript

await fetch("https://vbml.vestaboard.com/format", {
  headers: {
    "Content-Type": "application/json",
  },
  method: "POST",
  body: JSON.stringify({
    message: "Hello World",
  }),
}).then((res) => res.json());

Example Response

[
  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  [0, 0, 0, 0, 0, 8, 5, 12, 12, 15, 0, 23, 15, 18, 12, 4, 0, 0, 0, 0, 0, 0],
  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]