⌘ K

Search

Search portal content

AI customer support in one tabAI customer support in one tab
⌘ K

Search

Search portal content

AI customer support in one tabAI customer support in one tab
  • Quickstart
  • Organization profile and avatar
  • Invite team members
  • How to manage tickets
  • Migration Guide
  • API access
  1. Home
  2. Get started

API access

Use initdesk API to connect to internal systems

API access

Use initdesk API to connect to internal systems

Connecting via API

When developing with initdesk, it is important to distinguish between our BYOD (Bring Your Own Data) plugins and our Public API.

  • BYOD plugin is a UI and AI context extension. They allow you to pull real-time data from external databases directly into a custom card in the agent sidebar during a ticket conversation, being visible also for AI agents. See more info.](https://help.initdesk.com/plugins/byod-bring-your-own-data)
  • API integration is a system-level tool. It allows your external applications to programmatically create, read, update, and delete core initdesk objects (tickets, contacts, organizations) on demand.

For exact endpoint specifications, rate limits, and authentication headers, see the initdesk Developer Reference.


Core Use Cases

1. Programmatic Ticket Management

  • Automated Incident Logging: Trigger support tickets automatically from external infrastructure monitoring or alerting platforms when system errors occur.

  • Workflow Automation: Update ticket statuses, assign owners, or append internal notes when an engineer changes an issue status in an external project tracker.

2. Contact and Organization Sync

  • CRM Alignment: Keep user records, subscription tiers, and customer preferences consistent between your central CRM and initdesk.

  • Bulk Account Updates: Programmatically add tags or update customer organization fields based on external account changes or platform activation milestones.

3. Data Pipelines and Analytics

  • Data Warehousing: Periodically extract ticket volume, response metrics, and agent conversation data to ingest into business intelligence platforms or data warehouses.

Getting Started

Step 1: Generate an API Key

  1. Log into your initdesk dashboard.

  2. Navigate to Settings > Developer Portal.

  3. Generate a new API token. Store this token securely, as it grants complete access to your system data. The API token is only shown once.

Step 2: Authenticate Requests

All API requests must pass securely over HTTPS. Include your generated token inside the authorization header for every request:

X-Initdesk-Token: {YOUR_API_TOKEN}

Go to initdesk Developer Reference.

Migration Guide

Move from other support tools to initdesk.

Handle support email

Connect an email account to create a shared inbox so all support messages appear in one place.

Powered by initdesk
On this page
  • API access
  • Connecting via API
  • Core Use Cases
  • Getting Started