DOCS Guides, API and best practices

Everything you need to get started.

Setup, advanced configuration, integrations, REST API and webhooks. All in one place.

Getting started

Create account · Invite team · Configure channels · First ticket

  • Create account
  • Invite the team
  • Your first ticket
  • Configure email-to-ticket

Tickets

Full workflow: states, priorities, assignment and escalations.

  • States and priorities
  • Automatic assignment
  • Macros and templates
  • SLA escalations

SLA

Time policies, pre-breach alerts and compliance reports.

  • Create SLA policies
  • Pause by state
  • Alerts and notifications
  • Compliance reports

Automations

Rules, triggers and actions. No-code setup.

  • Triggers
  • Conditions
  • Chained actions
  • External webhooks

Knowledge base

Markdown editor, categories, public portal.

  • Create articles
  • Categorization
  • Public portal
  • Usage metrics

Roles and permissions

Granular per-module control. SSO + SAML on Enterprise.

  • System roles
  • Custom roles
  • SSO + SAML
  • SCIM provisioning

REST API

Endpoints, authentication, pagination, rate limits.

  • Token auth
  • Ticket endpoints
  • Webhooks
  • Rate limits

Integrations

Slack, Teams, Jira, GitHub, Zapier, Make.

  • Slack
  • Microsoft Teams
  • Jira
  • Custom webhooks

Administration

Branding, custom domains, billing, data residency.

  • Branding
  • Custom domain
  • Billing
  • Compliance and residency
REST API

Simple API. Complex outcome.

Create tickets, read state, sync users and more with consistent REST endpoints. Bearer token auth, cursor-based pagination, signed webhooks.

POST /api/v1/tickets
curl -X POST https://api.kydesk.com/v1/tickets \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "VPN no conecta",
    "priority": "high",
    "requester_email": "u@empresa.com"
}'

Can't find what you're looking for?

Our team replies within 24 business hours.