Create Message with Vestaboard API

Pipedream makes it easy to connect APIs for Vestaboard and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Message with the Vestaboard API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Message with the Vestaboard API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Message action
1. Connect your Vestaboard account
2. Select a Subscription
3. Optional- Configure Text
4. Optional- Configure Characters
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Message with Vestaboard API on New Requests from HTTP / Webhook API

HTTP / Webhook + Vestaboard

Try it

Create Message with Vestaboard API on New Submission from Typeform API

Typeform + Vestaboard

Try it

Create Message with Vestaboard API on New Submission (Instant) from Jotform API

Jotform + Vestaboard

Try it

Create Message with Vestaboard API on New Custom Webhook Events from Stripe API

Stripe + Vestaboard

Try it

Create Message with Vestaboard API on New Scheduled Tasks from Pipedream API

Pipedream + Vestaboard

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Message on Vestaboard

Description:Creates a new message for a subscription. [See the docs](https://swagger.vestaboard.com/docs/vestaboard/b3A6MTYwMTA4OTc-post-v2-0-subscriptions-with-id-message)

Version:0.0.2

Key:vestaboard-create-message

View on GitHub

Code#

import vestaboard from "../../vestaboard.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "vestaboard-create-message",
  name: "Create Message",
  description: "Creates a new message for a subscription. [See the docs](https://swagger.vestaboard.com/docs/vestaboard/b3A6MTYwMTA4OTc-post-v2-0-subscriptions-with-id-message)",
  version: "0.0.2",
  type: "action",
  props: {
    vestaboard,
    subscriptionId: {
      propDefinition: [
        vestaboard,
        "subscriptionId",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "The message to send to the specified Subscription. If text is specified, lines will be centered horizontally and vertically if possible. Character codes will be inferred for alphanumeric and punctuation, or can be explicitly specified in-line in the message with curly braces containing the character code. Either `text` or `characters` must be entered.",
      optional: true,
    },
    characters: {
      type: "string",
      label: "Characters",
      description: "A 6x22 two-dimensional array of character codes to send to the specified Subscription. If characters are specified, the characters will be shown in the exact position in the array. [See Character Code Reference](https://docs.vestaboard.com/characters). Either `text` or `characters` must be entered.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      subscriptionId,
      text,
      characters,
    } = this;

    if (!text && !characters) {
      throw new ConfigurationError("Either `text` or `characters` must be entered");
    }

    const data = {};
    if (text) {
      data.text = text;
    } else {
      data.characters = Array.isArray(characters)
        ? characters
        : JSON.parse(characters);
    }

    const response = await this.vestaboard.createMessage({
      subscriptionId,
      data,
      $,
    });

    if (response) {
      $.export("$summary", `Successfully created message with ID ${response.message.id}`);
    }

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Vestaboard	`vestaboard`	`app`	This component uses the Vestaboard app.
Subscription	`subscriptionId`	`string`	Select a value from the drop down menu.
Text	`text`	`string`	The message to send to the specified Subscription. If text is specified, lines will be centered horizontally and vertically if possible. Character codes will be inferred for alphanumeric and punctuation, or can be explicitly specified in-line in the message with curly braces containing the character code. Either `text` or `characters` must be entered.
Characters	`characters`	`string`	A 6x22 two-dimensional array of character codes to send to the specified Subscription. If characters are specified, the characters will be shown in the exact position in the array. See Character Code Reference. Either `text` or `characters` must be entered.

Authentication#

Vestaboard uses API keys for authentication. When you connect your Vestaboard account, Pipedream securely stores the keys so you can easily authenticate to Vestaboard APIs in both code and no-code steps.

To retrieve your API keys,