Skip to content

Commit af0993f

Browse files
committed
DOCS: BuildShip Extension
Signed-off-by: BeeBombshell <[email protected]>
1 parent 8c1c341 commit af0993f

File tree

8 files changed

+131
-0
lines changed

8 files changed

+131
-0
lines changed

docs/extensions/assets/buildship1.png

690 KB
Loading

docs/extensions/assets/buildship2.png

68.4 KB
Loading

docs/extensions/assets/buildship3.png

114 KB
Loading

docs/extensions/assets/buildship4.png

198 KB
Loading

docs/extensions/assets/buildship5.png

152 KB
Loading

docs/extensions/assets/buildship6.png

189 KB
Loading

docs/extensions/buildship.mdx

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
id: buildship
3+
title: BuildShip Extension
4+
slug: /extensions/buildship
5+
---
6+
7+
import buildship1 from "./assets/buildship1.png";
8+
import buildship2 from "./assets/buildship2.png";
9+
import buildship3 from "./assets/buildship3.png";
10+
import buildship4 from "./assets/buildship4.png";
11+
import buildship5 from "./assets/buildship5.png";
12+
import buildship6 from "./assets/buildship6.png";
13+
14+
Now you can easily connect your **Firebase data on Rowy to an API**, perform
15+
read and write operations, and **trigger complex workflows triggered by simple
16+
Create, Update, and Delete events** within your Rowy Table using
17+
[BuildShip](https://www.buildship.com).
18+
19+
## What is BuildShip? 👀
20+
21+
<img src={buildship1} alt="BuildShip low code backend builder" />
22+
23+
BuildShip is a **low-code, AI-based visual backend and workflow builder created
24+
by Rowy**. It simplifies the creation of APIs and backend workflows, offering
25+
seamless integration with AI Models, third-party APIs, and a library of over 1
26+
million NPM packages.
27+
28+
[Learn more about BuildShip here.](http://www.buildship.com)
29+
30+
Now you can easily link your Rowy table data to your API built on BuildShip.
31+
32+
Trigger your backend API call every time you create, update, or delete a field
33+
in your Rowy table. This has been made possible with the “**BuildShip
34+
Extension**”.
35+
36+
With the BuildShip Extension, you can effortlessly connect your Rowy Table to
37+
your backend workflows on BuildShip.
38+
39+
:::info What you can do with the BuildShip Extension 🤩
40+
41+
Imagine having a Rowy table for new user sign-ups for your product. Now,
42+
effortlessly trigger a backend workflow that sends a Welcome email, subscribes
43+
them to your product’s weekly newsletter, and notifies you via Discord/Slack
44+
message with their plan details.
45+
46+
It’s all possible with the BuildShip Trigger extension! ⬇️ :::
47+
48+
## Pre-requisites ✅
49+
50+
- A BuildShip project (No additional set up required. Click
51+
[here](https://www.buildship.app) to sign up.)
52+
53+
## Creating a BuildShip Workflow
54+
55+
- After creating a new workflow in BuildShip, click on **Add a Trigger** and
56+
select **Rowy Trigger** from the available options.
57+
58+
- In the **Project ID** field add your **Rowy Project ID**. Click on the link
59+
icon on the top right within the trigger to copy the configuration details
60+
required for the next steps.
61+
62+
<img src={buildship2} alt="buildship rowy trigger" />
63+
64+
:::tip Get your Rowy Project ID To get your Rowy Project ID, go to your Rowy
65+
Table and click on your profile picture on the top right. You'll find the
66+
Project ID under the your Email Id.
67+
68+
<img src={buildship3} alt="buildship rowy trigger" />
69+
:::
70+
71+
This is all you need to do in BuildShip to set up the Rowy Trigger. Now, let's
72+
set up the BuildShip Extension our Rowy Table.
73+
74+
## Setting up the Extension in Rowy
75+
76+
- In your Rowy Table, access the extensions menu and add a "**BuildShip Trigger
77+
Extension**".
78+
79+
<img src={buildship4} alt="buildship rowy trigger" />
80+
81+
- **Select Trigger Events** within Rowy that will trigger the BuildShip
82+
extension. You can select from events:
83+
- `Create`
84+
- `Update`
85+
- `Delete`
86+
87+
<img src={buildship3} alt="buildship rowy trigger" />
88+
89+
- Optionally, you can **define the required fields** that must be populated to
90+
trigger the extension.
91+
92+
- If needed, **add conditions** that determine whether the extension should be
93+
triggered for a given row.
94+
95+
- Within the extension body, navigate to the return statement. Fnd the
96+
`buildshipConfig` object, which includes the following fields:
97+
98+
```js
99+
buildshipConfig: {
100+
projectId: "",
101+
workflowId: ""
102+
}
103+
```
104+
105+
- Replace the placeholder with the configuration details copied from your
106+
BuildShip Rowy Trigger. It should look something like this:
107+
108+
```js
109+
buildshipConfig: {
110+
projectId: "buildship-008vd0",
111+
workflowId: "zE49cCs5kBmg7GkUwzLt"
112+
}
113+
```
114+
115+
<img src={buildship6} alt="buildship rowy trigger" />
116+
117+
- Once you've configured the extension to your requirements, click on "**Add**"
118+
and then deploy the extension.
119+
120+
Now, whenever the selected event (Create, Update, or Delete) occurs in your Rowy
121+
Table, it will trigger the BuildShip workflow linked to this extension.
122+
123+
BuildShip showcases a wide range of pre-built templates that you can easily
124+
clone and use for your own projects. You can also build your own custom
125+
workflows from scratch. Leverage this powerful duo for your projects and tell us
126+
what you think!
127+
128+
:::info Let us know what you think! 💜 We'd love to hear your feedback on this
129+
extension. Chat with us and our community of low-code/no-code builders and
130+
developers on [Discord](https://buildship.com/discord). :::

sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ module.exports = {
201201
collapsed: true,
202202
items: [
203203
"extensions/overview",
204+
"extensions/buildship",
204205
"extensions/algolia-index",
205206
"extensions/sendgrid-email",
206207
"extensions/twilio-message",

0 commit comments

Comments
 (0)