Activating the Firstbase Node

Overview

The Firstbase node is the anchor node for every Firstbase Workflow. It supports both Triggers (start a workflow when something changes in Firstbase) and Actions (make an API call to read or write Firstbase data). It is the foundation to automating device lifecycle processes. 

Common Use Cases Include:

• Trigger a workflow when a New Joiner appears in Firstbase, to create their accounts in other connected systems (Jira, Okta, Microsoft Teams, etc.) ahead of their start date
• Trigger a workflow when a device return or replacement is created in Firstbase, to open a follow-up ticket in Jira or ServiceNow for IT
• Trigger a workflow when an offboarding task changes in Firstbase, to deactivate accounts in Okta and notify the employee's team in Microsoft Teams
• Use a Firstbase action (e.g. approve an order, update an inventory item) as the final step of a workflow that started in another connected system

Connection Overview

The Firstbase node authenticates using a Firstbase API key. A user must have admin access in order to be able to create an API. You must generate this key and create the credential below before any Firstbase action or trigger will work; once saved, the credential can be attached to any workflow step that reads from or writes to Firstbase.

Firstbase API Key Setup

To connect to Firstbase, you will need:

• A Firstbase API Key

Step 1: Sign in as an admin

Sign in to the Firstbase platform as an admin user.

Step 2: Navigate to API Access

Go to API & Integrations > API Access

Step 3: Generate a token

Select Generate Token. Give the token a name, and choose an expiration timeline for it. The new token appears at the top of your API token list with a Copy button next to it. Select Copy to copy the generated token.

Important:  API Keys Attributes

Firstbase API Keys are attached to the org and not the user. All API Keys have full admin rights. If the user leaves, the API Key will not be affected. 

Important:  Generate the key from the correct org

API keys are created by an admin and are scoped to a single Firstbase organization. If your organization has more than one Firstbase org (for example, separate sandbox, subsidiary, or regional orgs), make sure you generate the key from the correct one, as a key from the wrong org will result in errors.

Setup in Firstbase Workflows

This can be saved as a global credential, reusable across workflows, or scoped to a single workflow.

Step 1: Navigate to Workflows

In the Firstbase platform, as an admin, click the Workflows tab.

Step 2: Create the new credential

In Workflows, click Credentials > Create Credential (top right), type "Firstbase", and select Firstbase API. 

Paste the bare token value into the API Key field. Leave Allowed HTTP Request Domains at All unless your organization wants to restrict this credential's calls to Firstbase's own API domain specifically. Click Save.

Important: The API Key preface generally required to use the Firstbase API key (e.i “ApiKey <generated token>”) is NOT required. If it is used, it will not connect correctly. 

Step 3: Using the credential in a workflow

Add the Firstbase node (for an Action to make an API call to read or write Firstbase data) or a Firstbase trigger node (to start a workflow when something changes in Firstbase, such as a new order, a new joiner, or an inventory change) to your workflow, and select the Firstbase credential you just created. 

Questions? Reach out to your Firstbase Solutions Engineer or Customer Success Manager