In this tutorial we’ll share an overview over how integrations work in PixieBrix.
Integrations in PixieBrix are defined as the API-keys or tokens used to authenticate with 3rd party service providers.
Integrations come under the umbrella of bricks. However for these bricks to work, they require these special integrations details.
There are two types of integrations on the PixieBrix platform: 1) ⛅️ Cloud Integrations: Can work across PixieBrix installs, and are sync’d up in the cloud between you and your team(s) accounts
2) ⚙️ Integrations: These “personal” integrations live - unlike the previous type - inside your browser and are personal to you. If you delete them from PixieBrix (manually or by deleting your PixieBrix extension) these are gone.
Let’s talk about Cloud Integrations first..
Navigate to: https://app.pixiebrix.com/
As the page opens on the left hand side menu there’s an entry called
Cloud Integrations - click it to open up the Cloud Integrations page
You should now see a list of your Cloud Integrations. In the screenshot below, notice a red a blue arrows:
The red arrow points to +Add Integration, which is how to add a new Cloud Integration.
If you click it, a drop-down appears where you can configure any supported Cloud Integration by entering the relevant details, such as API key.
For example, one of our supported Cloud Integrations is Airtable. The first field, Organization, is the organization or PixieBrix team that will get access to the integration.
Once enter all the required fields and click Save, the integration becomes active and can be used by anyone in your organization.
To delete a Cloud Integration click Configure under the Actions column
and select Delete
Now let’s go back to the original Cloud Dashboard screenshot.
If you click the blue arrow you will be taken to the extension’s internal page - from the side menu click on the Integration link - which will open the
Integrations can also be accessed by clicking the PixieBrix extension button in the Chrome extension bar (to the right of the address bar) and choosing Options ⚙️
These integrations are local, meaning these integrations are stored in your browser; they are never transmitted to the PixieBrix servers or shared with your team.
Similar to the previous page, you can add your integrations by pressing the blue Add Integration blue button.
Here’s an example of an integration - Airtable and what fields are required for you to fill to have a working integration:
How to use integrations in PixieBrix
When you open the page editor, on certain bricks you will notice a field with a dropdown with your integrations.
If you click the dropdown you can choose between your Cloud Integration (that either you or a team-mate might have added to your organization’s account) and any Integration you might have added, locally.
In the screenshot below the field for the integration is called
airtableapi - but it varies by brick.
All integration fields have a short text prompting you to configure additional integrations. If you click on the link you will be taken to the local integrations page by default. That’s the page we discussed earlier
That’s all folks!