Introduction
Core Products
Resources
🚀
Getting Started
A quick start guide to Buildable instant backend toolkits
⏲ Estimated time to complete this guide: < 5 minutes
In this short guide, we’re going to show how easy it is to create, test and deploy your first endpoint using any of the 2,000+ open-source Integration Templates available to you as a Buildable developer.
This guide assumes that you already have a buildable account setup. New to Buildable? Get access for free here.
⚡️ Step 1: Create a Flow
Creating a Flow can be done easily by clicking the
Create a flow button located on the upper left-hand side of the Buildable dashboard. A popup will open where you will be prompted to enter a name and optional description for your Flow.Once you click
Create, you will be redirected to the canvas, which is where you can start working on your Flow. It’s as easy as that!
Creating a Flow
🪄 Step 2: Add your Nodes
Customize your URL and Response
A Flow is an active endpoint that can handle 10M+ monthly calls and can be triggered at any time (and from anywhere) by simply calling its endpoint URL. You can customize your Flow's endpoint URL, as well as its Response, via the Trigger node.
To start customizing your Flow, you'll want to start adding Nodes below your Trigger.
Add Nodes using the Template library
Nodes are the building blocks of your endpoint. You can add custom Nodes, like an empty JavaScript function or Axios function, or select from Buildable's library of pre-built, enterprise-grade and fully open-source integration templates.
To add a Node, simply hover over the Trigger node and add click the '+' button. This will open Buildable's template library, which makes it easy to search, select and configure any integration or utility you're looking to use.
Interested in Web3? Take a peek at our Web3 category, which contains Coinbase, Tatum, etc.. Want to set up payment rails? Check out our Stripe templates. You get the point.
All Templates are free and 100% open-source under the MIT license.
In this case, we're going to use Stripe's
create customer template to show how it all works.Configure your Node
When adding Nodes, you'll notice certain Templates require integration keys. For example, Stripe requires a Stripe Secret Key, SendGrid requires an API Key, etc...
Buildable allows you to add your keys securely using Environment Variables at the time you're adding a Node to make it as easy as possible for you. However, you can also add them directly via the Environment Variables console in your dashboard at any time.
You only need to create an Environment Variable for your platform API keys once. Once you add an environment variable to your account, it can be accessed anywhere in your Nodes using
$trigger.env.<environment-variable-name>🚀 Step 3: Test!
Once your Flow is built, you'll want to run a test to see if everything's working as planned. To do so, you can use the in-browser test environment, called the Playground, which is available in the top right corner of your canvas.
Using the Playground, you can provide your Flow a sample body and run it. Once you run your Flow, you can assess its output, errors if they exist, any available logs, etc... Debugging is now a breeze.
That's it! Now, its time to learn more about our core products:
Last modified 3mo ago
Copy link