Using the SDK and REST API

Helmdesk provides a fully typed Node.js SDK and a REST API for programmatic access to your project's tickets, emails, and articles.

Installing the SDK

Install the official SDK from npm:

`bash

npm install @helmdesk/sdk

`

The SDK works in Node.js 18+, Deno, Bun, and Cloudflare Workers.

Getting Your API Key

Navigate to your project in the dashboard

Click API Keys in the sidebar

Click + Generate Key

Copy the key and store it securely

API keys are project-scoped and use Bearer token authentication.

SDK Quick Start

`typescript

import { Helmdesk } from '@helmdesk/sdk'

const client = new Helmdesk({ apiKey: 'your-api-key' })

// List tickets

const tickets = await client.tickets.list()

// Create a ticket

const ticket = await client.tickets.create({

subject: 'Need help with billing',

body: 'I have a question about my invoice.',

customerEmail: 'customer@example.com'

})

// Send an email

await client.emails.send({

to: 'user@example.com',

template: 'welcome',

variables: { name: 'Jane' }

})

`

REST API

The REST API is available at https://helmdesk.dev/api/v1/ with 12 endpoints covering tickets, emails, templates, articles, and AI features. See the full API documentation at /docs for request/response schemas.

Webhooks

Set up webhooks to receive real-time notifications when events occur in your project (new tickets, status changes, etc.). Configure webhooks in your project's Webhooks settings.