API reference

Every v1 method. Each one names the scope it needs.

Me

GET/v1/meNo scope required

Who am I

Key, company and limits. No scope required.

Response · 200 · MeDto

curl -X GET "https://api.tg-desk.com/v1/me" \
  -H "Authorization: Bearer $TYGY_API_KEY"

Conversations

GET/v1/conversationsScope: conversations:read

List conversations

Newest activity first. Scope: `conversations:read`.

Parameters

Field	Type	Description
limit	`string` query · optional	Page size, 1…100
starting_after	`string` query · optional	Cursor from the previous page’s `next_cursor`
status	`string` query · optional
assignee_id	`string` query · optional	User id of the assigned operator
contact_id	`string` query · optional
tag	`string` query · optional	Tag id
channel	`string` query · optional	Channel the conversation came in on
updated_since	`string` query · optional	Only conversations changed at or after this ISO-8601 instant — for polling

Response · 200 · ConversationPageDto

curl -X GET "https://api.tg-desk.com/v1/conversations" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/conversations/{id}Scope: conversations:read

Get a conversation

Parameters

Field	Type	Description
id	`string` path · required

Response · 200 · ConversationDto

curl -X GET "https://api.tg-desk.com/v1/conversations/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

PATCH/v1/conversations/{id}Scope: conversations:write

Update a conversation

Status, assignee and team. Goes through the same transitions the inbox uses — audit line, notifications and scenarios fire as for an operator. Scope: `conversations:write`.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
status	`string` optional	`open` reopens a closed/spam dialog, wakes a snoozed one or unassigns an assigned one; `snoozed` needs `snoozed_until`; to assign, set `assignee_id` instead. `open`, `closed`, `snoozed`, `spam`
assignee_id	`string \| null` optional	User id, or null to unassign
team_id	`string \| null` optional	Team id, or null to clear
snoozed_until	`string` optional	Required with `status: snoozed`

Response · 200 · ConversationDto

curl -X PATCH "https://api.tg-desk.com/v1/conversations/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

GET/v1/conversations/{id}/messagesScope: conversations:read

List messages of a conversation

Oldest first by default. Internal notes (`type: note`) are returned only to keys holding `notes:write`.

Parameters

Field	Type	Description
id	`string` path · required
limit	`string` query · optional	Page size, 1…100
starting_after	`string` query · optional	Cursor from the previous page’s `next_cursor`
order	`string` query · optional	Oldest first by default

Response · 200 · MessagePageDto

curl -X GET "https://api.tg-desk.com/v1/conversations/<id>/messages" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/conversations/{id}/messagesScope: messages:send

Send a reply or leave a note

Attributed to the key («API · <name>» in the inbox). `type: reply` needs `messages:send` and is delivered on the conversation’s channel; `type: note` needs `notes:write` and stays internal.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
body	`string` required	Plain text; Markdown is rendered where the channel supports it
type	`string` optional	`reply` reaches the customer (scope `messages:send`); `note` stays internal (scope `notes:write`) `reply`, `note`

Response · 201 · MessageDto

curl -X POST "https://api.tg-desk.com/v1/conversations/<id>/messages" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body": "…"}'

POST/v1/conversations/{id}/tagsScope: conversations:write

Add a tag to a conversation

Idempotent.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
tag_id	`string` required

Response · 200 · ConversationDto

curl -X POST "https://api.tg-desk.com/v1/conversations/<id>/tags" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tag_id": "…"}'

DELETE/v1/conversations/{id}/tags/{tagId}Scope: conversations:write

Remove a tag from a conversation

Idempotent.

Parameters

Field	Type	Description
id	`string` path · required
tagId	`string` path · required

Response · 200 · ConversationDto

curl -X DELETE "https://api.tg-desk.com/v1/conversations/<id>/tags/<tagId>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

Contacts

GET/v1/contactsScope: contacts:read

List contacts

Most recently updated first. Scope: `contacts:read`.

Parameters

Field	Type	Description
limit	`string` query · optional	Page size, 1…100
starting_after	`string` query · optional	Cursor from the previous page’s `next_cursor`
q	`string` query · optional	Case-insensitive substring of the name
email	`string` query · optional	Exact e-mail (any identifier)
phone	`string` query · optional	Exact phone (any identifier)
organization_id	`string` query · optional
updated_since	`string` query · optional

Response · 200 · ContactPageDto

curl -X GET "https://api.tg-desk.com/v1/contacts" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/contactsScope: contacts:write

Create a contact

An e-mail / phone / Telegram username already known in the project answers 409 with the existing id — the same address never creates a second person. Scope: `contacts:write`.

Request body

Field	Type	Description
name	`string` required
email	`string` optional
phone	`string` optional	E.164 preferred; national formats are normalised
telegram_username	`string` optional
organization_id	`string` optional	Client organization to link the contact to

Response · 201 · ContactDto

curl -X POST "https://api.tg-desk.com/v1/contacts" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "…"}'

GET/v1/contacts/{id}Scope: contacts:read

Get a contact

Parameters

Field	Type	Description
id	`string` path · required

Response · 200 · ContactDto

curl -X GET "https://api.tg-desk.com/v1/contacts/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

PATCH/v1/contacts/{id}Scope: contacts:write

Update a contact

Absent fields stay; null clears.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
name	`string \| null` optional
email	`string \| null` optional	Replaces the primary e-mail; null removes it
phone	`string \| null` optional
telegram_username	`string \| null` optional
organization_id	`string \| null` optional	null unlinks

Response · 200 · ContactDto

curl -X PATCH "https://api.tg-desk.com/v1/contacts/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

POST/v1/contacts/{id}/identifiersScope: contacts:write

Add an e-mail / phone / Telegram username to a contact

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
type	`string` required	`email`, `phone`, `telegram`
value	`string` required

Response · 200 · ContactDto

curl -X POST "https://api.tg-desk.com/v1/contacts/<id>/identifiers" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type": "email", "value": "…"}'

DELETE/v1/contacts/{id}/identifiers/{identifierId}Scope: contacts:write

Remove an identifier from a contact

Parameters

Field	Type	Description
id	`string` path · required
identifierId	`string` path · required

Response · 200 · ContactDto

curl -X DELETE "https://api.tg-desk.com/v1/contacts/<id>/identifiers/<identifierId>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/contacts/{id}/tagsScope: contacts:write

Add a tag to a contact

Idempotent.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
tag_id	`string` required

Response · 200 · ContactDto

curl -X POST "https://api.tg-desk.com/v1/contacts/<id>/tags" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tag_id": "…"}'

DELETE/v1/contacts/{id}/tags/{tagId}Scope: contacts:write

Remove a tag from a contact

Idempotent.

Parameters

Field	Type	Description
id	`string` path · required
tagId	`string` path · required

Response · 200 · ContactDto

curl -X DELETE "https://api.tg-desk.com/v1/contacts/<id>/tags/<tagId>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

Organizations

GET/v1/organizationsScope: contacts:read

List client organizations

The B2B accounts contacts work for. Scope: `contacts:read`.

Parameters

Field	Type	Description
limit	`string` query · optional	Page size, 1…100
starting_after	`string` query · optional	Cursor from the previous page’s `next_cursor`
q	`string` query · optional	Case-insensitive substring of the name
updated_since	`string` query · optional

Response · 200 · OrganizationPageDto

curl -X GET "https://api.tg-desk.com/v1/organizations" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/organizationsScope: contacts:write

Create a client organization

Scope: `contacts:write`.

Request body

Field	Type	Description
name	`string` required
email	`string` optional
phone	`string` optional
website	`string` optional

Response · 201 · OrganizationDto

curl -X POST "https://api.tg-desk.com/v1/organizations" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "…"}'

GET/v1/organizations/{id}Scope: contacts:read

Get a client organization

Parameters

Field	Type	Description
id	`string` path · required

Response · 200 · OrganizationDto

curl -X GET "https://api.tg-desk.com/v1/organizations/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

PATCH/v1/organizations/{id}Scope: contacts:write

Rename a client organization

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
name	`string` optional

Response · 200 · OrganizationDto

curl -X PATCH "https://api.tg-desk.com/v1/organizations/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

POST/v1/organizations/{id}/tagsScope: contacts:write

Add a tag to a client organization

Idempotent.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
tag_id	`string` required

Response · 200 · OrganizationDto

curl -X POST "https://api.tg-desk.com/v1/organizations/<id>/tags" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tag_id": "…"}'

DELETE/v1/organizations/{id}/tags/{tagId}Scope: contacts:write

Remove a tag from a client organization

Idempotent.

Parameters

Field	Type	Description
id	`string` path · required
tagId	`string` path · required

Response · 200 · OrganizationDto

curl -X DELETE "https://api.tg-desk.com/v1/organizations/<id>/tags/<tagId>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

Field	Type	Description
scope	`string` query · optional

Team

GET/v1/usersScope: team:read

List users (operators)

Active members only. Scope: `team:read`.

Response · 200 · UserListDto

curl -X GET "https://api.tg-desk.com/v1/users" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/teamsScope: team:read

List teams

Scope: `team:read`.

Response · 200 · TeamListDto

curl -X GET "https://api.tg-desk.com/v1/teams" \
  -H "Authorization: Bearer $TYGY_API_KEY"

Help center

GET/v1/kb/handbooksScope: kb:read

List handbooks

Active help centers of the project. Scope: `kb:read`.

Response · 200 · HandbookListDto

curl -X GET "https://api.tg-desk.com/v1/kb/handbooks" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/kb/handbooks/{id}/categoriesScope: kb:read

List categories of a handbook

Parameters

Field	Type	Description
id	`string` path · required

Response · 200 · CategoryListDto

curl -X GET "https://api.tg-desk.com/v1/kb/handbooks/<id>/categories" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/kb/articlesScope: kb:read

List published articles

Titles only; fetch one article for its body.

Parameters

Field	Type	Description
limit	`string` query · optional	Page size, 1…100
starting_after	`string` query · optional	Cursor from the previous page’s `next_cursor`
q	`string` query · optional	Search words. Matches the article title and its short description, case-insensitively. The body is not searched — ask for the article to read it.
handbook_id	`string` query · optional	Restrict to one handbook
category_id	`string` query · optional	Restrict to one category
updated_since	`string` query · optional

Response · 200 · ArticlePageDto

curl -X GET "https://api.tg-desk.com/v1/kb/articles" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/kb/articlesScope: kb:write

Create an article

The body is Markdown. Creates a DRAFT unless `status` says otherwise — a sync that goes wrong should not publish. Publishing is also what re-indexes the article for the AI operator. Scope: `kb:write`.

Request body

Field	Type	Description
handbook_id	`string` required	Which handbook the article belongs to
title	`string` required	Title of the article in this locale
markdown	`string` required	The body, as Markdown. Headings, paragraphs, lists and tables are understood; the same reader the file import uses converts it, so the result is identical to a typed article.
locale	`string` optional	Defaults to the handbook's own locale
category_id	`string \| null` optional
slug	`string` optional	Derived from the title when omitted
status	`string` optional	Defaults to `draft`. Publishing is what re-indexes it for the AI operator. `draft`, `published`, `archived`

Response · 201 · ArticleDto

curl -X POST "https://api.tg-desk.com/v1/kb/articles" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handbook_id": "…", "title": "…", "markdown": "…"}'

GET/v1/kb/articles/{id}Scope: kb:read

Get a published article with its body

Parameters

Field	Type	Description
id	`string` path · required
locale	`string` query · optional	Return only this locale’s body (all locales by default)

Response · 200 · ArticleDto

curl -X GET "https://api.tg-desk.com/v1/kb/articles/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

PATCH/v1/kb/articles/{id}Scope: kb:write

Update an article

Every field is optional. Sending `markdown` replaces the body for that locale and requires `title` alongside it, because a translation carries both. Scope: `kb:write`.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
title	`string` optional
markdown	`string` optional	Requires `title` alongside it
locale	`string` optional
category_id	`string \| null` optional
slug	`string` optional
status	`string` optional	`draft`, `published`, `archived`

Response · 200 · ArticleDto

curl -X PATCH "https://api.tg-desk.com/v1/kb/articles/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

POST/v1/kb/categoriesScope: kb:write

Create a category

Scope: `kb:write`.

Request body

Field	Type	Description
handbook_id	`string` required
slug	`string` required
translations	`CategoryTranslationInputDto[]` required
parent_id	`string \| null` optional	Nest under another category

Response · 201 · CategoryDto

curl -X POST "https://api.tg-desk.com/v1/kb/categories" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handbook_id": "…", "slug": "…", "translations": "…"}'

PATCH/v1/kb/categories/{id}Scope: kb:write

Update a category

Scope: `kb:write`.

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
slug	`string` optional
parent_id	`string \| null` optional
translations	`CategoryTranslationInputDto[]` optional

Response · 200 · CategoryDto

curl -X PATCH "https://api.tg-desk.com/v1/kb/categories/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Analytics

GET/v1/analytics/overviewScope: analytics:read

Overview

Headline numbers, the daily series and when the load actually lands. Scope: `analytics:read`.

Parameters

Field	Type	Description
from	`string` query · optional	ISO-8601 start. Default: 30 days back.
to	`string` query · optional	ISO-8601 end. Default: now. The period must not exceed 366 days.
channel	`string` query · optional	Narrow to channels. Comma-separated, or repeat the parameter.
team	`string` query · optional	Team ids, comma-separated or repeated.
operator	`string` query · optional	User ids, comma-separated or repeated.

Response · 200 · OverviewReportDto

curl -X GET "https://api.tg-desk.com/v1/analytics/overview" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/analytics/channelsScope: analytics:read

By channel

Volume, share, resolved share and resolution speed per channel. Scope: `analytics:read`.

Parameters

Field	Type	Description
from	`string` query · optional	ISO-8601 start. Default: 30 days back.
to	`string` query · optional	ISO-8601 end. Default: now. The period must not exceed 366 days.
channel	`string` query · optional	Narrow to channels. Comma-separated, or repeat the parameter.
team	`string` query · optional	Team ids, comma-separated or repeated.
operator	`string` query · optional	User ids, comma-separated or repeated.

Response · 200 · ChannelsReportDto

curl -X GET "https://api.tg-desk.com/v1/analytics/channels" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/analytics/teamsScope: analytics:read

By team

The same numbers per team, plus the team × channel breakdown. Scope: `analytics:read`.

Parameters

Field	Type	Description
from	`string` query · optional	ISO-8601 start. Default: 30 days back.
to	`string` query · optional	ISO-8601 end. Default: now. The period must not exceed 366 days.
channel	`string` query · optional	Narrow to channels. Comma-separated, or repeat the parameter.
team	`string` query · optional	Team ids, comma-separated or repeated.
operator	`string` query · optional	User ids, comma-separated or repeated.

Response · 200 · TeamsReportDto

curl -X GET "https://api.tg-desk.com/v1/analytics/teams" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/analytics/operatorsScope: analytics:read

By operator

Taken, closed and replies per operator. Scope: `analytics:read`.

Parameters

Field	Type	Description
from	`string` query · optional	ISO-8601 start. Default: 30 days back.
to	`string` query · optional	ISO-8601 end. Default: now. The period must not exceed 366 days.
channel	`string` query · optional	Narrow to channels. Comma-separated, or repeat the parameter.
team	`string` query · optional	Team ids, comma-separated or repeated.
operator	`string` query · optional	User ids, comma-separated or repeated.

Response · 200 · OperatorsReportDto

curl -X GET "https://api.tg-desk.com/v1/analytics/operators" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/analytics/revenueScope: analytics:read

Revenue

Won revenue, conversion and the split by channel and operator. Scope: `analytics:read`.

Parameters

Field	Type	Description
recognition	`string` query · optional	Which date the money counts on. Default: `won`.
from	`string` query · optional	ISO-8601 start. Default: 30 days back.
to	`string` query · optional	ISO-8601 end. Default: now. The period must not exceed 366 days.
channel	`string` query · optional	Narrow to channels. Comma-separated, or repeat the parameter.
team	`string` query · optional	Team ids, comma-separated or repeated.
operator	`string` query · optional	User ids, comma-separated or repeated.

Response · 200 · RevenueReportDto

curl -X GET "https://api.tg-desk.com/v1/analytics/revenue" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/analytics/qualityScope: analytics:read

Dialog quality

AI evaluation of dialogs: average, distribution and the weekly trend. Scope: `analytics:read`.

Parameters

Field	Type	Description
from	`string` query · optional	ISO-8601 start. Default: 30 days back.
to	`string` query · optional	ISO-8601 end. Default: now. The period must not exceed 366 days.
channel	`string` query · optional	Narrow to channels. Comma-separated, or repeat the parameter.
team	`string` query · optional	Team ids, comma-separated or repeated.
operator	`string` query · optional	User ids, comma-separated or repeated.

Response · 200 · QualityReportDto

curl -X GET "https://api.tg-desk.com/v1/analytics/quality" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/analytics/botScope: analytics:read

AI operator

How often the agent was used, and how those dialogs ended. Scope: `analytics:read`.

Parameters

Field	Type	Description
from	`string` query · optional	ISO-8601 start. Default: 30 days back.
to	`string` query · optional	ISO-8601 end. Default: now. The period must not exceed 366 days.
channel	`string` query · optional	Narrow to channels. Comma-separated, or repeat the parameter.
team	`string` query · optional	Team ids, comma-separated or repeated.
operator	`string` query · optional	User ids, comma-separated or repeated.

Response · 200 · BotReportDto

curl -X GET "https://api.tg-desk.com/v1/analytics/bot" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/analytics/filtersScope: analytics:read

Filter values

The channels, teams and operators that actually appear in this project — so a caller filters by real values instead of guessing. Scope: `analytics:read`.

Response · 200 · AnalyticsFiltersDto

curl -X GET "https://api.tg-desk.com/v1/analytics/filters" \
  -H "Authorization: Bearer $TYGY_API_KEY"

Meetings

GET/v1/meetingsScope: conferences:read

List meetings

Newest first. Scope: `conferences:read`.

Parameters

Field	Type	Description
limit	`string` query · optional	Page size, 1…100
starting_after	`string` query · optional	Cursor from the previous page’s `next_cursor`

Response · 200 · MeetingPageDto

curl -X GET "https://api.tg-desk.com/v1/meetings" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/meetings/{id}Scope: conferences:read

Get a meeting with its summary and transcript

The summary and the transcript are present once the meeting reaches `ready`; before that they are null. Scope: `conferences:read`.

Parameters

Field	Type	Description
id	`string` path · required

Response · 200 · MeetingDetailDto

curl -X GET "https://api.tg-desk.com/v1/meetings/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

Webhooks

GET/v1/webhooksScope: webhooks:manage

List webhook subscriptions

Scope: `webhooks:manage`.

Response · 200 · WebhookListDto

curl -X GET "https://api.tg-desk.com/v1/webhooks" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/webhooksScope: webhooks:manage

Create a webhook subscription

The signing secret is returned once, here. Verify a delivery as `HMAC-SHA256("<X-Webhook-Timestamp>.<raw body>", secret)` against `X-Webhook-Signature`.

Request body

Field	Type	Description
name	`string` required	How the subscription is labelled in the settings list
url	`string` required	https:// endpoint (http:// allowed for localhost only)
events	`string[]` required

Response · 201 · WebhookWithSecretDto

curl -X POST "https://api.tg-desk.com/v1/webhooks" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "…", "url": "…", "events": ["…"]}'

GET/v1/webhooks/{id}Scope: webhooks:manage

Get a webhook subscription

Parameters

Field	Type	Description
id	`string` path · required

Response · 200 · WebhookDto

curl -X GET "https://api.tg-desk.com/v1/webhooks/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

PATCH/v1/webhooks/{id}Scope: webhooks:manage

Update a webhook subscription

Parameters

Field	Type	Description
id	`string` path · required

Request body

Field	Type	Description
name	`string` optional
url	`string` optional
events	`string[]` optional
active	`boolean` optional	false pauses deliveries; true clears a pause

Response · 200 · WebhookDto

curl -X PATCH "https://api.tg-desk.com/v1/webhooks/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/v1/webhooks/{id}Scope: webhooks:manage

Delete a webhook subscription

Parameters

Field	Type	Description
id	`string` path · required

Response · 204

curl -X DELETE "https://api.tg-desk.com/v1/webhooks/<id>" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/webhooks/{id}/rotate-secretScope: webhooks:manage

Rotate the signing secret

The new secret is returned once. Deliveries in flight are signed with the new one.

Parameters

Field	Type	Description
id	`string` path · required

Response · 200 · WebhookWithSecretDto

curl -X POST "https://api.tg-desk.com/v1/webhooks/<id>/rotate-secret" \
  -H "Authorization: Bearer $TYGY_API_KEY"

POST/v1/webhooks/{id}/testScope: webhooks:manage

Send a test event

Queues a `webhook.test` delivery with a sample body; watch it in the log. The delivery is asynchronous, so the answer is `202` — it says the event was queued, not that the endpoint replied.

Parameters

Field	Type	Description
id	`string` path · required

Response · 202 · WebhookTestResultDto

curl -X POST "https://api.tg-desk.com/v1/webhooks/<id>/test" \
  -H "Authorization: Bearer $TYGY_API_KEY"

GET/v1/webhooks/{id}/deliveriesScope: webhooks:manage

Delivery log of a subscription

Newest first, kept for 7 days.

Parameters

Field	Type	Description
id	`string` path · required
limit	`string` query · required

Response · 200 · WebhookDeliveryListDto

curl -X GET "https://api.tg-desk.com/v1/webhooks/<id>/deliveries" \
  -H "Authorization: Bearer $TYGY_API_KEY"

API reference

Me

Who am I

Conversations

List conversations

Get a conversation

Update a conversation

List messages of a conversation

Send a reply or leave a note

Add a tag to a conversation

Remove a tag from a conversation

Contacts

List contacts

Create a contact

Get a contact

Update a contact

Add an e-mail / phone / Telegram username to a contact

Remove an identifier from a contact

Add a tag to a contact

Remove a tag from a contact

Organizations

List client organizations

Create a client organization

Get a client organization

Rename a client organization

Add a tag to a client organization

Remove a tag from a client organization

Tags

List tags

Team

List users (operators)

List teams

Help center

List handbooks

List categories of a handbook

List published articles

Create an article

Get a published article with its body

Update an article

Create a category

Update a category

Analytics

Overview

By channel

By team

By operator

Revenue

Dialog quality

AI operator

Filter values

Meetings

List meetings

Get a meeting with its summary and transcript

Webhooks

List webhook subscriptions

Create a webhook subscription

Get a webhook subscription

Update a webhook subscription

Delete a webhook subscription

Rotate the signing secret

Send a test event

Delivery log of a subscription