@buildable/client
v1.0.1
Published
Buildable is a fully managed event bus lets you send and receive data across mission-critical cloud apps, databases and warehouses.
Downloads
8
Readme
@buildable/client
Buildable is the easiest way to collect, stream, transform and action your backend system events. Buildable simplifies the process of communicating between services or cloud apps via events.
This library allows you to quickly and easily emit and listen on events via Node.js.
Setup
In order to use emit and listen on events, you'll need a Buildable account and Secret Key. Follow these steps:
- Create an account at buildable.dev
- Connect a Node.js Source within the Sources page
- Copy the Secret Key from the Setup tab
- Install the package (see below)
- Start emitting your events
Install Package
Install the @buildable/client
NPM package in your working code environment:
> npm install @buildable/client
Emitting Events
The emit requires:
event
- The name of the eventpayload
- The data of the event
Once an event is emitted, it will be visible immediately in the Live Events feed in your Buildable developer dashboard.
Using NodeJS
const { createClient } = require('@buildable/client');
const client = createClient(process.env.BUILDABLE_SECRET_KEY);
client.emit("user.created", {
name: "John Doe"
});
Want to use cURL instead?
curl --location --request POST 'https://events.buildable.dev/emit' \
--header 'X-Buildable-Secret: <YOUR SECRET KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"event": "user.created",
"payload": {
"name": "John Doe"
}
}'
Listening on Events
What is a transaction?
A transaction is an action that can be triggered when an event is received. An event can have multiple transactions. Each transaction has:
- An input value
- An output value
- A unique transaction key (
txKey
) per event
Transacting on custom events from your Node.JS source
const { createClient } = require('@buildable/client');
const client = createClient(process.env.BUILDABLE_SECRET_KEY);
// Transact on `user.created`
client.on("user.created", async ({ event, payload }) => {
console.log("Receieved event with payload: ", payload);
// Any value returned here will be set as the transaction's output
return {
success: true
};
});
Transacting on platform events from your cloud app sources
When listening on events from cloud apps, simply add two additional options to the listener:
const { createClient } = require('@buildable/client');
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);
// Any value returned here will be set as the transaction's output
}, {
platform: "stripe", // Platform name
label: "my-stripe-connection" // Connection name
});
Multiple transactions on an event
In order to trigger multiple transactions on the same event, you must specify a custom transaction key (txKey
). For example, if two services need to listen on the same event and trigger different custom logic, each service must pass a unique txKey to the listener.
const { createClient } = require('@buildable/client');
const client = createClient(process.env.BUILDABLE_SECRET_KEY);
// Transaction #1 on `user.created` from service A
client.on("user.created", async ({ event, payload }) => {
// Set the notification.sent transaction output
return await sendNotification(payload);
}, {
txKey: "notification.sent"
});
// Transaction #2 on `user.created` from service B
client.on("user.created", async ({ event, payload }) => {
// Set the salesforce.customer.created transaction output
return await createCustomerOnSalesForce(payload);
}, {
txKey: "salesforce.customer.created"
});
*By default, the txKey
is set to sdk.{{EVENT_NAME}}
Transacting on historical events
In order to transact on events that have already been emitted in the past, simply pass in the additional configuration argument since
. For example, to transact on messages from 10 days ago:
client.on("user.created", async ({ event, payload }) => {
// Set the notification.sent transaction output
return await sendNotification(payload);
}, {
txKey: "notification.sent",
since: Date.now() - (10 * 24 * 60 * 60 * 1000) // Since 10 days ago
});
API
Alternatively, you can use the Buildable API. Learn more about it at docs.buildable.dev
Need More Help?
💻 Website: https://buildable.dev
📄 Docs: https://docs.buildable.dev
💬 Discord: https://discord.com/invite/47AJ42Wzys
🐦 Twitter: https://twitter.com/BuildableHQ
License
© 2022, Buildable Technologies Inc. - Released under the MIT License