n8n: Getting Started

The tutorial below takes users through a typical configuration of the n8n DIMO node. To learn more about n8n, including external connections/integrations, please refer to the n8n Documentation.

Prerequisites for Building on n8n

Our first featured integration is with n8n, a low code workflow automation tool. N8n has over 1000+ integrations, which means the n8n DIMO node can seamlessly connect to platforms and services you are already familiar with. Before getting started with n8n, follow the steps below:

1

Create A Developer License

Create a Developer License by signing up for an account on the DIMO Developer Console (if you’re not a developer, don’t worry – this is going to be easy!)

2

Create An Application

Once you’re logged in, click “Create Application” and fill in the basic application details fields.

3

Generate API Keys & Redirect URI

From the Application Details page, locate your Client ID, generate an API Key, and add at least 1 Redirect URI. The Redirect URI can be any valid web URL while you’re getting started.

4

Get Vehicles Shared with You

To get the most out of n8n, we recommend getting at least one vehicle to share privileged access with your developer license. To do so, you can either share your own vehicle with yourself using your Client ID and Redirect URI via the Login with DIMO URL, or have other DIMO users share their vehicle with you. (If you need vehicles to test with, let us know by contacting support).

After you've followed these steps, there are a few ways to get connected to n8n:

Option 1 (Recommended for non-developers):

• Register for a cloud account (includes a free trial).

Option 2 (Recommended for developers):

• Locally via npm or Docker.

Installing the DIMO Node via npm

The DIMO Node is an npm package that can be installed directly alongside the n8n installation. Simply install the below package in the root directory of your n8n project:

npm: n8n-nodes-dimo-apinpm

The DIMO n8n node via npm

Setting Your Credentials in the n8n DIMO node

In order to begin using the DIMO node in n8n, you'll first need to set up authentication credentials. From your n8n Home screen, select the "Credentials" tab > "Add Credential" > Select "DIMO API" from the dropdown.

In the DIMO account credentials screen, enter your Client ID, Redirect URI, and API Key as obtained from the DIMO Developer Console app you created earlier. We recommend keeping the Environment set to "Production".

Adding credentials in the DIMO n8n node

Adding Your First DIMO node

Once you've saved your credentials, you're ready to begin using the DIMO node.

As a first step, in a new workflow file, set an initial Trigger that will be used to begin the workflow. If you're just getting started, you can set this to "Trigger Manually" – this will manually run you workflow when clicked.

From there, click the + button next to the Trigger node, and search for DIMO.

The available actions for the DIMO node

Select one of the DIMO actions you're interested in from the sidebar, which are described in greater detail below:

DIMO node Actions

Attestation API Actions

Use the Attestation API to create a Verifiable Credential (VC) for VIN or POM.

Available Actions:

• Create VIN VC

• Create POM VC

Related Documentation: Attestation API

Authentication API Actions

Use the Vehicle JWT action to quickly obtain a short-lived JWT. Especially useful for rapid prototyping or testing out Telemetry API queries in the Telemetry Playground: https://telemetry-api.dimo.zone/

Available Actions:

• Get Vehicle JWT

Related Documentation: Authentication | Token Exchange API

Device Definitions API Actions

Use this action to submit a decoding request for a vehicle, or return a list of device definitions based on custom search filters.

Available Actions:

• Decode VIN

• Search

Related Documentation: Device Definitions API

Identity API Actions

Use this action to perform custom GraphQL queries on the DIMO Identity API. You can think of the Identity API as your way of accessing a public catalog of DIMO-connected devices, vehicles, rewards, and developer licenses.

Available Actions:

• Count DIMO Vehicles

• Custom Identity Query

Related Documentation: Identity API

Telemetry API Actions

Use this action to perform custom GraphQL queries on the DIMO Telemetry API. You can think of the Telemetry API as a way to access telematics (think: tire pressure, odometer, VIN, etc.) from vehicles that have granted you privileged access to that data. Please note, because this is a privileged endpoint, you can only access vehicle data for users who have granted you permission via a Login with DIMO flow.

Available Actions:

• Get Vehicle VIN

• Custom Telemetry Query

Related Documentation: Telemetry API | Login with DIMO (for permission sharing)

Trips API Actions

Use this action to retrieve trip data from vehicles that have granted you privileged access to that data. Please note, because this is a privileged endpoint, you can only access trips data for users who have granted you permission via a Login with DIMO flow. (additional note: R1 devices are currently not supported, but will in the near future).

Available Actions:

• Get Trips

Related Documentation: Trips API | Login with DIMO (for permission sharing)

Valuations API Actions

Use this action to lookup valuations, submit an offers request from third party servies, or get a list of vehicle offers for a vehicle tokenId.

Available Actions:

• Valuations Lookup

• Get Instant Offer

• List Existing Offers

Related Documentation: Valuations API | Login with DIMO (for permission sharing)

Connecting to External Services

You can read more about how to use DIMO data by connecting the DIMO node to third party services (such as creating AI Agents, Airtable, Google Sheets, etc.) by reviewing n8n's documentation here.

Looking for DIMO Webhooks or Triggers within n8n? These are coming soon, and will be announced publicly in the near future. Stay tuned!