You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Create a [Bubble](https://bubble.io){:target=_blank .external-link} account.
18
-
-[Create an app](https://manual.bubble.io/help-guides/getting-started/creating-and-managing-apps#creating-apps){:target=_blank .external-link} within that account.
19
-
20
-
/// note | Bubble plans
21
-
You need a Starter plan or higher to access the Bubble API.
15
+
/// note | API access
16
+
You need a paid plan to access the Bubble APIs.
22
17
///
23
18
24
19
## Supported authentication methods
@@ -31,12 +26,32 @@ Refer to [Bubble's API documentation](https://manual.bubble.io/help-guides/integ
31
26
32
27
## Using API key
33
28
34
-
To configure this credential, you'll need:
35
-
36
-
- An **API Token**: Refer to the [Bubble Authentication documentation](https://manual.bubble.io/core-resources/api/the-bubble-api/the-data-api/authentication){:target=_blank .external-link} for instructions on creating a new API token.
37
-
- An **App Name**: The name of the app you created the API token for.
38
-
- The **Environment**: Choose between **Live** or **Development**. Select the environment that makes sense for your app.
39
-
- The **Hosting**:
40
-
-**Bubble Hosting**: Choose this option if you haven't set up a custom domain
41
-
-**Self Hosting**: Choose this option if you've set up a [custom domain](https://manual.bubble.io/help-guides/design/elements/the-page#custom-domain-1){:target=_blank .external-link} in Bubble. Add the **Domain**.
42
-
29
+
To configure this credential, you'll need a paid [Bubble](https://bubble.io){:target=_blank .external-link} account and:
30
+
31
+
- An **API Token**
32
+
- An **App Name**
33
+
- Your **Domain**, if you're using a custom domain
34
+
35
+
To set it up, you'll need to create an app:
36
+
37
+
1. Go to the [**Apps**](https://bubble.io/home/apps){:target=_blank .external-link} page in Bubble.
38
+
1. Select **Create an app**.
39
+
1. Enter a **Name** for your app, like `n8n-integration`.
40
+
1. Select **Get started**. The app's details open.
41
+
1. In the left navigation, select **Settings** (the gear cog icon).
42
+
1. Select the **API** tab.
43
+
1. In the **Public API Endpoints** section, check the box to **Enable Data API**.
44
+
1. The page displays the **Data API root URL**, for example: `https://n8n-integration.bubbleapps.io/version-test/api/1.1/obj`.
45
+
1. Copy the part of the URL after `https://` and before `.bubbleapps.io` and enter it in n8n as the **App Name**. In the above example, you'd enter `n8n-integration`.
46
+
1. Select **Generate a new API token**.
47
+
8. Enter an **API Token Label**, like `n8n integration`.
48
+
1. Copy the **Private key** and enter it as the **API Token** in your n8n credential.
49
+
- Refer to [Data API | Authentication](https://manual.bubble.io/core-resources/api/the-bubble-api/the-data-api/authentication){:target=_blank .external-link} for more information on generating API tokens.
50
+
1. In n8n, select the **Environment** that best matches your app:
51
+
- Select **Development** for an app that you haven't deployed, accessed at `https://appname.bubbleapps.io/version-test` or `https://www.mydomain.com/version-test`.
52
+
- Select **Live** for an app that you've [deployed](https://manual.bubble.io/help-guides/getting-started/navigating-the-bubble-editor/deploying-your-app){:target=_blank .external-link}, accessed at `https://appname.bubbleapps.io` or `https://www.mydomain.com`.
53
+
1. In n8n, select your **Hosting**:
54
+
- If you haven't set up a custom domain, select **Bubble Hosting**.
55
+
- If you've set up a [custom domain](https://manual.bubble.io/help-guides/getting-started/navigating-the-bubble-editor/tabs-and-sections/settings-tab/custom-domain-and-dns){:target=_blank .external-link}, select **Self Hosted** and enter your custom **Domain**.
56
+
57
+
Refer to Bubble's [Creating and managing apps](https://manual.bubble.io/help-guides/getting-started/creating-and-managing-apps){:target=_blank .external-link} documentation for more information.
0 commit comments