⌘ 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
  • Setting up webhooks
  • API access
  • Using the initdesk MCP Server
  • Notifications
  1. Home
  2. Integrations & notifications

API access

Use the initdesk API to connect tickets, customers, messages, and Help Center content with internal systems and automations.

API access

Use the initdesk API to connect tickets, customers, messages, and Help Center content with internal systems and automations.

Use the initdesk API when another system needs to create, read, update, or sync initdesk data programmatically.

The API is different from BYOD plugins and MCP. BYOD shows external data inside the ticket sidebar. MCP lets an AI assistant act through your logged-in user permissions. The API is for system-to-system workflows where your application calls initdesk directly.

For endpoint details, schemas, and examples, use the initdesk Developer Reference.

What you can build with the API

Ticket automation

Create tickets from monitoring tools, product events, contact forms, or internal systems. You can also update ticket status, add internal notes, or sync external workflow changes back to initdesk.

Customer and organization sync

Keep customer records aligned between initdesk and your CRM, billing system, product database, or data warehouse.

Help Center workflows

Create, search, and update Help Center content from external tools. This is useful for migrations, content audits, and workflows that turn repeated support questions into draft articles.

Reporting and analytics

Export ticket, customer, and message data into your own reporting stack when you need custom dashboards or long-term analysis outside initdesk.

Get an API token

  1. Open initdesk.
  2. Go to Settings > API access.
  3. Generate a new API token.
  4. Copy it and store it securely. The token is only shown once.

Authenticate requests

Send your token in the X-Initdesk-Token header on every request:

X-Initdesk-Token: YOUR_API_TOKEN

Use HTTPS for all requests.

Find your organization ID

Most API paths include your numeric organization ID:

/organizations/{organization_id}/

You can find it in Settings > General inside initdesk.

API, webhooks, BYOD, and MCP

Use the API when your system needs to call initdesk on demand.

Use webhooks when initdesk should send ticket events to your system automatically.

Use BYOD when initdesk should display live customer data from your API inside the ticket sidebar.

Use MCP when ChatGPT, Claude, or another MCP-compatible assistant should work with tickets, customers, and Help Center content on behalf of a logged-in initdesk user.

Check service status before debugging

If API requests, webhook delivery, or email-related workflows fail unexpectedly, check status.initdesk.com before debugging your integration.

The status page shows current availability for core services, active incidents, and incident history. This helps you tell whether the issue is local to your integration or already being investigated by initdesk.

Troubleshooting

Requests return unauthorized

Check that the token is present in the X-Initdesk-Token header and that you copied the full token when it was created.

The organization cannot be found

Confirm that you are using the numeric organization ID from Settings > General, not the organization name or public slug.

The request works locally but fails in production

Verify that your production environment has the same token and base URL configuration, and check status.initdesk.com for any active API or webhook incident.

I need an endpoint that is not available yet

Contact support and describe the workflow you want to automate. We use API requests to prioritize new endpoints.

On this page
  • API access
  • What you can build with the API
  • Ticket automation
  • Customer and organization sync
  • Help Center workflows
  • Reporting and analytics
  • Get an API token
  • Authenticate requests
  • Find your organization ID
  • API, webhooks, BYOD, and MCP
  • Check service status before debugging
  • Troubleshooting
Setting up webhooks

Forward ticket events from initdesk to your own HTTPS endpoint—how delivery, retries, events, and payloads work.

Using the initdesk MCP Server

Connect any MCP-compatible AI client to initdesk to manage tickets, customers, and knowledge base articles in natural language.

Powered by initdesk