@triargos/dashboard-node v3.0.0

Dashboard Node.js SDK

Node.js library for the Dashboard API

Install

npm install @triargos/dashboard-node
# or
yarn add @triargos/dashboard-node

Setup

First, you need to obtain an API key from the integrations page in the Dashboard.

import {Dashboard} from "@triargos/dashboard-node";

const dashboard = new Dashboard({apiKey: "db_1234", environment: "staging"})

You can specify a set of environments

• production (default): Queries the production API endpoint
• staging: Queries the staging API endpoint
• development: Queries the development API endpoint (http://localhost:3000)

Usage

Listing organizations

!CAUTION You can only list organizations that have your integration installed.

const {data, error} = await dashboard.client.get("/v1/organizations")

After listing organizations, you can take the organization id to perform additional operations

Listing persons

const {data} = await dashboard.client.GET("/v1/organizations/{organizationId}/persons", {
    params: {
        path: {
            organizationId: "123"
        }
    }
})

License

MIT License