Zendesk
Тикеты, пользователи и организации Zendesk в процессах Pailot
Zendesk — платформа поддержки: тикеты, пользователи и организации. Блок ходит в API (Application Programming Interface — программный интерфейс) Zendesk.
С Zendesk в Pailot вы можете:
- Читать список тикетов с фильтрами, один тикет, создавать и обновлять по одному и пачками (до 100)
- Удалять тикет и сливать несколько в целевой
- Управлять пользователями: список, поиск, текущий, создание, правка, удаление, пачками
- Работать с организациями: список, автодополнение по имени, создание, правка, удаление, пачками
- Искать по тикетам, пользователям и организациям и считать число совпадений
Нужны email агента, токен API и поддомен (для mycompany.zendesk.com это mycompany).
Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Секреты — в переменных окружения рабочего пространства.
Список тикетов с фильтрами.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен (например mycompany для mycompany.zendesk.com) |
status | string | Нет | Фильтр по статусу: new, open, pending, hold, solved, closed |
priority | string | Нет | Фильтр по приоритету: low, normal, high, urgent |
type | string | Нет | Фильтр по типу: problem, incident, question, task |
assigneeId | string | Нет | Фильтр по ID исполнителя |
organizationId | string | Нет | Фильтр по ID организации |
sortBy | string | Нет | Поле сортировки: created_at, updated_at, priority, status |
sortOrder | string | Нет | Порядок: asc или desc |
perPage | string | Нет | Результатов на странице (по умолчанию 100, макс. 100) |
page | string | Нет | Номер страницы |
| Параметр | Тип | Описание |
|---|
tickets | array | Тикеты |
paging | object | Постраничный вывод |
↳ next_page | string | URL следующей страницы |
↳ previous_page | string | URL предыдущей страницы |
↳ count | number | Всего тикетов |
metadata | object | Метаданные ответа |
↳ total_returned | number | Число тикетов в этом ответе |
↳ has_more | boolean | Есть ли ещё тикеты |
Один тикет по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
ticketId | string | Да | ID тикета |
| Параметр | Тип | Описание |
|---|
ticket | object | Объект тикета |
ticket_id | number | ID тикета |
Новый тикет, в том числе с пользовательскими полями.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
subject | string | Нет | Тема (если не задана — сгенерируется) |
description | string | Да | Описание (первый комментарий) |
priority | string | Нет | Приоритет: low, normal, high, urgent |
status | string | Нет | Статус: new, open, pending, hold, solved, closed |
type | string | Нет | Тип: problem, incident, question, task |
tags | string | Нет | Теги через запятую |
assigneeId | string | Нет | ID исполнителя |
groupId | string | Нет | ID группы |
requesterId | string | Нет | ID заявителя |
customFields | string | Нет | Пользовательские поля JSON (например {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
ticket | object | Созданный тикет |
ticket_id | number | ID созданного тикета |
Пакетное создание тикетов (макс. 100).
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
tickets | string | Да | JSON-массив тикетов (макс. 100). У каждого — subject и comment |
| Параметр | Тип | Описание |
|---|
job_status | object | Статус фоновой задачи |
job_id | string | ID пакетной операции |
Обновление тикета, в том числе пользовательских полей.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
ticketId | string | Да | ID тикета |
subject | string | Нет | Новая тема |
comment | string | Нет | Добавить комментарий |
priority | string | Нет | Приоритет: low, normal, high, urgent |
status | string | Нет | Статус: new, open, pending, hold, solved, closed |
type | string | Нет | Тип: problem, incident, question, task |
tags | string | Нет | Теги через запятую |
assigneeId | string | Нет | ID исполнителя |
groupId | string | Нет | ID группы |
customFields | string | Нет | Пользовательские поля JSON |
| Параметр | Тип | Описание |
|---|
ticket | object | Обновлённый тикет |
ticket_id | number | ID обновлённого тикета |
Пакетное обновление тикетов (макс. 100).
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
ticketIds | string | Да | ID тикетов через запятую (макс. 100) |
status | string | Нет | Новый статус для всех |
priority | string | Нет | Новый приоритет для всех |
assigneeId | string | Нет | Новый исполнитель для всех |
groupId | string | Нет | Новая группа для всех |
tags | string | Нет | Теги через запятую — добавить ко всем |
| Параметр | Тип | Описание |
|---|
job_status | object | Статус фоновой задачи |
job_id | string | ID пакетной операции |
Удаление тикета.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
ticketId | string | Да | ID тикета |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Удалось ли удалить |
ticket_id | string | ID удалённого тикета |
Слияние нескольких тикетов в целевой.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
targetTicketId | string | Да | ID целевого тикета (в него сольют остальные) |
sourceTicketIds | string | Да | ID исходных тикетов через запятую |
targetComment | string | Нет | Комментарий в целевой тикет после слияния |
| Параметр | Тип | Описание |
|---|
job_status | object | Статус фоновой задачи |
job_id | string | ID задачи слияния |
target_ticket_id | string | ID целевого тикета |
Список пользователей с фильтрами.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен (например mycompany для mycompany.zendesk.com) |
role | string | Нет | Фильтр по роли: end-user, agent, admin |
permissionSet | string | Нет | Фильтр по ID набора прав |
perPage | string | Нет | Результатов на странице (по умолчанию 100, макс. 100) |
page | string | Нет | Номер страницы |
| Параметр | Тип | Описание |
|---|
users | array | Пользователи |
paging | object | Постраничный вывод |
↳ next_page | string | URL следующей страницы |
↳ previous_page | string | URL предыдущей страницы |
↳ count | number | Всего пользователей |
metadata | object | Метаданные ответа |
↳ total_returned | number | Число пользователей в этом ответе |
↳ has_more | boolean | Есть ли ещё пользователи |
Один пользователь по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
userId | string | Да | ID пользователя |
| Параметр | Тип | Описание |
|---|
user | object | Объект пользователя |
user_id | number | ID пользователя |
Текущий авторизованный пользователь.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
| Параметр | Тип | Описание |
|---|
user | object | Текущий пользователь |
user_id | number | ID текущего пользователя |
Поиск пользователей по строке или внешнему ID.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
query | string | Нет | Поисковый запрос |
externalId | string | Нет | Внешний ID |
perPage | string | Нет | Результатов на странице (по умолчанию 100, макс. 100) |
page | string | Нет | Номер страницы |
| Параметр | Тип | Описание |
|---|
users | array | Пользователи |
paging | object | Постраничный вывод |
↳ next_page | string | URL следующей страницы |
↳ previous_page | string | URL предыдущей страницы |
↳ count | number | Всего пользователей |
metadata | object | Метаданные ответа |
↳ total_returned | number | Число пользователей в этом ответе |
↳ has_more | boolean | Есть ли ещё пользователи |
Новый пользователь.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
name | string | Да | Имя пользователя |
userEmail | string | Нет | Email пользователя |
role | string | Нет | Роль: end-user, agent, admin |
phone | string | Нет | Телефон |
organizationId | string | Нет | ID организации |
verified | string | Нет | true — пропустить подтверждение email |
tags | string | Нет | Теги через запятую |
customFields | string | Нет | Пользовательские поля JSON (например {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
user | object | Созданный пользователь |
user_id | number | ID созданного пользователя |
Пакетный импорт пользователей.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
users | string | Да | JSON-массив пользователей |
| Параметр | Тип | Описание |
|---|
job_status | object | Статус фоновой задачи |
job_id | string | ID пакетной операции |
Обновление пользователя.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
userId | string | Да | ID пользователя |
name | string | Нет | Новое имя |
userEmail | string | Нет | Новый email |
role | string | Нет | Роль: end-user, agent, admin |
phone | string | Нет | Телефон |
organizationId | string | Нет | ID организации |
verified | string | Нет | true — отметить как подтверждённого |
tags | string | Нет | Теги через запятую |
customFields | string | Нет | Пользовательские поля JSON |
| Параметр | Тип | Описание |
|---|
user | json | Обновлённый пользователь |
user_id | number | ID обновлённого пользователя |
Пакетное обновление пользователей.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
users | string | Да | JSON-массив пользователей (у каждого должно быть поле id) |
| Параметр | Тип | Описание |
|---|
job_status | object | Статус фоновой задачи |
job_id | string | ID пакетной операции |
Удаление пользователя.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
userId | string | Да | ID пользователя |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Удалось ли удалить |
user_id | string | ID удалённого пользователя |
Список организаций.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен (например mycompany для mycompany.zendesk.com) |
perPage | string | Нет | Результатов на странице (по умолчанию 100, макс. 100) |
page | string | Нет | Номер страницы |
| Параметр | Тип | Описание |
|---|
organizations | array | Организации |
paging | object | Постраничный вывод |
↳ next_page | string | URL следующей страницы |
↳ previous_page | string | URL предыдущей страницы |
↳ count | number | Всего организаций |
metadata | object | Метаданные ответа |
↳ total_returned | number | Число организаций в этом ответе |
↳ has_more | boolean | Есть ли ещё организации |
Одна организация по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
organizationId | string | Да | ID организации |
| Параметр | Тип | Описание |
|---|
organization | json | Объект организации |
organization_id | number | ID организации |
Подсказка организаций по началу имени.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
name | string | Да | Имя или префикс для поиска |
perPage | string | Нет | Результатов на странице (по умолчанию 100, макс. 100) |
page | string | Нет | Номер страницы |
| Параметр | Тип | Описание |
|---|
organizations | array | Организации |
paging | object | Постраничный вывод |
↳ next_page | string | URL следующей страницы |
↳ previous_page | string | URL предыдущей страницы |
↳ count | number | Всего организаций |
metadata | object | Метаданные ответа |
↳ total_returned | number | Число организаций в этом ответе |
↳ has_more | boolean | Есть ли ещё организации |
Новая организация.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
name | string | Да | Название организации |
domainNames | string | Нет | Домены через запятую |
details | string | Нет | Сведения об организации |
notes | string | Нет | Заметки |
tags | string | Нет | Теги через запятую |
customFields | string | Нет | Пользовательские поля JSON (например {"field_id": "value"}) |
| Параметр | Тип | Описание |
|---|
organization | json | Созданная организация |
organization_id | number | ID созданной организации |
Пакетный импорт организаций.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
organizations | string | Да | JSON-массив организаций |
| Параметр | Тип | Описание |
|---|
job_status | object | Статус фоновой задачи |
job_id | string | ID пакетной операции |
Обновление организации.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
organizationId | string | Да | ID организации |
name | string | Нет | Новое название |
domainNames | string | Нет | Домены через запятую |
details | string | Нет | Сведения об организации |
notes | string | Нет | Заметки |
tags | string | Нет | Теги через запятую |
customFields | string | Нет | Пользовательские поля JSON |
| Параметр | Тип | Описание |
|---|
organization | json | Обновлённая организация |
organization_id | number | ID обновлённой организации |
Удаление организации.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
organizationId | string | Да | ID организации |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Удалось ли удалить организацию |
organization_id | string | ID удалённой организации |
Единый поиск по тикетам, пользователям и организациям.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
query | string | Да | Поисковый запрос |
sortBy | string | Нет | Поле сортировки: relevance, created_at, updated_at, priority, status, ticket_type |
sortOrder | string | Нет | Порядок: asc или desc |
perPage | string | Нет | Результатов на странице (по умолчанию 100, макс. 100) |
page | string | Нет | Номер страницы |
| Параметр | Тип | Описание |
|---|
results | array | Результаты поиска |
paging | object | Постраничный вывод |
↳ next_page | string | URL следующей страницы |
↳ previous_page | string | URL предыдущей страницы |
↳ count | number | Всего результатов |
metadata | object | Метаданные ответа |
↳ total_returned | number | Число результатов в этом ответе |
↳ has_more | boolean | Есть ли ещё результаты |
Число совпадений по поисковому запросу.
| Параметр | Тип | Обязательный | Описание |
|---|
email | string | Да | Email аккаунта Zendesk |
apiToken | string | Да | Токен API Zendesk |
subdomain | string | Да | Поддомен Zendesk |
query | string | Да | Поисковый запрос |
| Параметр | Тип | Описание |
|---|
count | number | Число совпадений |
