@buildable/messages

@buildable/messages

Buildable is the easiest way to collect, transform, send and action your backend system messages. Buildable simplifies the process of collecting message data from your disparate systems and connecting new tools to action those messages, allowing you to spend more of your engineering time on things that matter.

This library allows you to quickly and easily emit and listen on messages via Node.js.

Setup

In order to use emit and listen on messages, you'll need a Buildable account and Secret Key. Follow these steps:

• Create an account at messages.buildable.dev
• Head over to the Secret Keys section in the Settings page
• Click the + Create secret key button
• Name your Secret Key
• Click Create

Ensure you store the test and live keys somewhere safe (like a password manager).

Install Package

Install the @buildable/messages NPM package in your working code space:

> npm install @buildable/messages

Emitting Messages

Once a message is emitted, it will be visible immediately in the Messages Stream on your Buildable account.

NodeJS

const { createClient } = require('@buildable/messages');

const client = createClient(process.env.BUILDABLE_SECRET_KEY);

client.emit("my-message", { 
  salutation: "Hello world ⚡️"
});

Using cURL

curl --location --request POST 'https://events.buildable.dev/emit' \
  --header 'X-Buildable-Secret: <YOUR SECRET KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "event": "my-message",
    "payload": {
      "salutation": "Hello world ⚡️"
    }
}'

Listening on Messages

There are two cases for transacting on messages:

• Messages from internal apps using the Buildable SDK
• Messages from third-party cloud apps using Buildable Connections

Messages from internal apps using the Buildable SDK

const { createClient } = require('@buildable/messages');

const client = createClient(process.env.BUILDABLE_SECRET_KEY);

// Listen on `my-message`
client.on("my-message", async ({ event, payload }) => {
  console.log("Receieved message with payload: ", payload);
});

Messages from third-party cloud apps using Buildable Connections

All Connections act as a source of events, leveraging the power of WebHooks. Once you’ve created a Connection in Buildable and subscribed to at least 1 message type, messages will continually enter the Messages Stream. In most cases, once you create a Connection once, you can forget about it!

When listening on messages from cloud apps, simply add two additional options to the listener:

const { createClient } = require('@buildable/messages');

const client = createClient(process.env.BUILDABLE_SECRET_KEY);

// Listen on `customer.created` from Stripe
client.on("customer.created", async ({ event, payload }) => {
  console.log("Receieved message with payload: ", payload);
}, {
  platform: "stripe", // Platform name
  label: "my-stripe-connection" // Connection name
});

Need More Help?

💻 Website: https://buildable.dev/messages

📄 Docs: https://hub.buildable.dev

💬 Discord: https://discord.com/invite/47AJ42Wzys

🐦 Twitter: https://twitter.com/BuildableHQ

License

© 2022, Buildable Technologies Inc. - Released under the MIT License