#1605: Описание объектов и параметров для триггеров

Отредактирована: 90 дней назад

В Swarmica есть следующие события, используемые в качестве триггеров:

ArticleEvent - События Статьи
CustomFieldEvent - События Кастомного поля
KCSEvent - События KCS
TicketEvent - События Заявки
UserEvent - События Пользователя

Для каждого из событий передаются определенные параметры, которые можно использовать в скриптах. Ниже описаны эти параметры:

ArticleEvent

Параметр	Что делает	Значения
event	передает какое Событие произошло со Статьёй	"0" - "Unknown" "1" - "Article created" "2" - "Article user segment added" "3" - "Article published" "4" - "Article unpublished" "5" - "Article deleted" "6" - "Article undeleted" "7" - "Article author changed" "8" - "Article flagged" "9" - "Article unflagged" "10" - "Agent commented on article" "11" - "Customer commented on article" "12" - "Agent comment changed" "13" - "Agent comment deleted" "14" - "Customer comment deleted" "15" - "Article revision added" "16" - "Article status changed" "17" - "Article user segment deleted"
responsible	передает Исполнителя События	Объект user
date	передает дату События
old_value	передает старые значения параметров События
new_value	передает новые значения параметров События
article	передает Статью, с которой произошло Событие	Объект article

CustomFieldEvent

Параметр	Что делает	Значения
responsible	передает Исполнителя События	Объект user
date	передает дату События, связанного с Кастомным полем
old_value	передает старые значения параметров События
new_value	передает новые значения параметров События
field	передает Кастомное поле, с которым произошло Событие	Объект customfield
content_object	передает Объект, для которого произошло Событие	Объект ticket\|article\|user

KCSEvent

Параметр	Что делает	Значения
type	передает тип События	"1" - "Capture" "2" - "Link" "3" - "Flag" "4" - "Publish" "5" - "Unflag" "6" - "Unpublish" "7" - "Unlink"
responsible	передает Исполнителя События	Объект user
date	передает дату и время События
ticket	передает Заявку, связанную с Событием	Объект ticket
article	передает Статью, связанную с Событием	Объект article

TicketEvent

Параметр	Что делает	Значения
event	передает Событие, связанное с Заявкой	"0" - "Неизвестно" "1" - "Статья создана из заявки" "2" - "Статья добавлена к заявке" "20" - "Убрана связь со статьёй" "3" - "Статья помечена к исправлению" "4" - "Статус заявки изменён" "5" - "Агент прокомментировал заявку" "6" - "Клиент прокомментировал заявку" "7" - "Заявка оценена" "8" - "Приоритет заявки изменён" "9" - "Заявка создана" "10" - "Ответственный изменён" "11" - "Заявитель изменён" "12" - "Группа заявки изменена" "13" - "Платформа заявки изменена" "14" - "Продукт заявки изменён" "15" - "Версия заявки изменена" "16" - "Редакция заявки изменена" "17" - "Задача добавлена к заявке" "18" - "Задача удалена из заявки" "19" - "Пользовательское поле изменено" "21" - "Навык добавлен" "22" - "Навык удалён" "23" - "Связанная заявка добавлена" "24" - "Связанная заявка удалена" "25" - "Заявка объединена" "28" - "Агент добавил внутренний комментарий" "26" - "Чат-сессия по заявке начата" "27" - "Чат-сессия по заявке завершена" "29" - "Отправлено уведомление об ожидании" "30" - "Политика SLA заявки изменена" "31" - "Лицензия заявки изменена" "33" - "Заявка разветвлена" "34" - "Задача закрыта" "35" - "Задача открыта" "36" - "Применено правило автоназначения" "37" - "Внутренний комментарий изменён" "38" - "Признак «Статья не нужна» изменён" "39" - "Система Swarmica добавила автоматический ответ" "40" - "Оценка времени изменена" "41" - "Задача удалена" "42" - "Актив добавлен" "43" - "Актив удалён" "44" - "Актив обновлён" "45" - "Тема изменена" "46" - "Публичный комментарий изменён" "47" - "Комментарий удалён" "48" - "Пользователь добавлен в копию" "49" - "Пользователь удалён из копии" "50" - "Наблюдатель добавлен" "51" - "Наблюдатель удалён" "52" - "Внешняя заявка добавлена" "53" - "Публичный комментарий внешней заявки добавлен" "54" - "Заявка заблокирована" "55" - "Заявка разблокирована"
responsible	передает Исполнителя События	Объект user
date	передает дату События
old_value	передает старые значения параметров События
new_value	передает новые значения События
ticket	передает Заявку, в которой произошло Событие	Объект ticket
ticket_comment	Передает комментарии Заявки, в которой произошло Событие	Объект ticketcomment

UserEvent

Параметр	Что делает	Значения
event	Передает События, связанные с Пользователем	"0" - "Role changed" "1" - "Password changed" "2" - "Identity added" "3" - "Organization changed" "4" - "Schedule changed" "5" - "Name changed" "6" - "Status changed" "7" - "Merged into" "8" - "Merged from" "9" - "User created" "10" - "User logged into system" "11" - "Notification enabled" "12" - "Notification disabled" "13" - "Identity deleted" "14" - "2FA method added" "15" - "2FA method removed" "16" - "2FA enabled" "17" - "2FA disabled" "18" - "2FA bypassed (transport unavailable)" "19" - "2FA backup code used"
responsible	передает Исполнителя События	Объект user
date	передает дату События
old_value	передает старые Значения События
new_value	передает старые Значения События
user	передает Пользователя, с которым произошло Событие	Объект user

Когда происходит Событие, передается данные об этом Событии. Эта информация содержит информацию о Событии и Объекты, связанные с этим самым Событием. Ниже представлены списки параметров Объектов.

article

Статьи базы знаний

Параметр	Что делает	Значения
id	передаёт ID Статьи
status	передаёт статус Статьи	DRAFT - черновик UNAPPROVED - Непроверенная APPROVED - Проверенная PUBLISHED - Опубликованная ARCHIVED - Архивная
published_at	передает дату публикации Статьи
visibility	передает области доступа к Статье	ALL - для всех AUTHORIZED - для авторизованных пользователей SEGMENTS - для отдельных сегментов пользователей
segments	передает Сегменты пользователей	Объект usersegment
internal	передает является ли Статья внутренней(boolean)	TRUE\|FALSE
category	передает Категорию Статьи	Объект articlecategory
publisher	передает Редактора Статьи	Объект user
author	передает Автора Статьи	Объект user
is_flagged	передает помечена ли Статья к исправлению(boolean)	TRUE\|FALSE
updated_at	передает дату последнего редактирования Статьи
created_at	передает дату создания Статьи
t_links	передает количество связанных со Статьёй Заявок

articlecategory

Разделы статей базы знаний

Параметр	Что делает	Значения
uid	передает UID Раздела статей
public	передает является ли Раздел публичным(boolean)	TRUE\|FALSE
order	передает значение порядкового номера Раздела
created_at	передает дату создания Раздела
updated_at	передает дату последнего редактирования Раздела

articlecomment

Комментарии к Статье

Параметр	Что делает	Значения
id	передает id Комментария к статье
author	передает Автора Комментария	Объект user
public	передает является ли Комментарий публичным(boolean)	TRUE\|FALSE
is_staff	передает является ли Автор комментария Сотрудником(boolean)	TRUE\|FALSE
created_at	передает дату создания Комментария
updated_at	передает дату последнего редактирования Комментария

articlerevision

Версия статьи базы знаний

Параметр	Что делает	Значения
uid	передает UID Версии статьи
author	передает Автора Версии статьи	Объект user
latest	передает является ли Версия статьи самой свежей(boolean)	TRUE\|FALSE
restored_from	передает из какой Версии Статья была восстановлена	Объект articlerevision

channel

Каналы связи

Параметр	Что делает	Значения
uid	Передает UID Канала связи
channel_type	Передает тип Канала связи	"EMAIL" "TELEGRAM" "WHATSAPP" "MANGO_OFFICE" "WIDGET" "BILLMANAGER" "VK" "BEELINE_PBX" "MAX"

customfield

Кастомные поля

Параметр	Что делает	Значения
uid	передает UID Кастомного поля
field_type	передает тип Кастомного поля	"TEXT" - текст "TEXTAREA" - текстовое поле "NUMBER" - целое число "DECIMAL" - число с плавающей точкой "CHECKBOX" - чекбокс "DROPDOWN" - меню "DATE" - дата "DATETIME" - дата и время "REGEX" - регулярное выражение "OBJECT" - связанная сущность "BADGE" - бейдж "LINK" - ссылка

edition

Редакции Продукта

Параметр	Что делает	Значения
uid	передает UID Версии

group

Группа пользователей

Параметр	Что делает	Значения
uid	передает UID Группы пользователей

issue

Внешние задачи из сторонних систем(Gitlab, Jira и т.п.)

Параметр	Что делает	Значения
uid	передает UID Внешней задачи

license

Клиентские ключи

Параметр	Что делает	Значения
uid	передает UID Клиентского ключа

organization

Компании(клиенты)

Параметр	Что делает	Значения
uid	передает UID Компании

platform

Платформы Продукта

Параметр	Что делает	Значения
uid	передает UID Платформы

product

Продукты

Параметр	Что делает	Значения
event.product.uid	передает UID Продукта

schedule

Расписания

Параметр	Что делает	Значения
event.schedule.uid	передает UID Расписания
event.schedule.name	передает название Расписания
event.schedule.default	передает является ли данное Расписание дефолтным(по умолчанию)(boolean)	TRUE\|FALSE

skill

Навыки сотрудников

Параметр	Что делает	Значения
uid	передает UID навыка

slapolicy

Политики SLA

Параметр	Что делает	Значения
uid	передает UID Политики SLA

ticket

Заявки

Параметр	Что делает	Значения
id	передает ID Заявки
status	передает статус Заявки	"NEW" "OPEN" "PENDING" "HOLD" "SOLVED" "CLOSED" "DELETED" "MERGED"
group	передает Группу, на которую назначена Заявка	Объект group
priority	передает приоритет Заявки	"low" "normal" "high" "urgent"
assignee	передает Ответственного за Заявку	Объект user
requester	передает Заявителя Заявки	Объект user
cc	передает список добавленных в CC	Объект user
watchers	передает список Наблюдателей Заявки	Объект user
organization	передает Компанию Заявителя	Объект organization
ticketsla	передает Политику SLA Заявки	Объект ticketsla
license	передает пользовательский Ключ Заявителя	Объект license
locked	передает заблокирована ли Заявка(boolean)	TRUE\|FALSE
tz_offset_minutes	передает часовой пояс Заявки
locale	передает язык(локаль) Заявки
created_at	передает дату создания Заявки
updated_at	передает дату последнего обновления Заявки
resolved_at	передает дату решения Заявки
until	передает дату, до которой Заявка будет в статусе Ожидание
replies	передает количество ответов в Заявке
reopens	передает количество переоткрытий Заявки
product	передает Продукт, по которому заведена Заявки	Объект product
version	передает версию Продукта	Объект version
edition	передает редакцию Продукта	Объект edition
platform	передает платформу Продукта	Объект platform
skills	передает Навыки, связанные с Заявкой	Объект skill
is_fcr	передает решена ли Заявка первым ответом Сотрудника(boolean)	TRUE\|FALSE
satisfaction_score	передает оценку удовлетворенности Заявителя	"UNOFFERED" "OFFERED" "GOOD" "BAD" "NEUTRAL"
time_estimate	передает Оценку трудозатрат Заявки
time_spent	передает фактические Трудозатраты на Заявку
article_not_needed	передает значение параметра "Статья не нужна"(boolean)	TRUE\|FALSE
article_links	передает количество связанных с Заявкой Статей
channels	передает Каналы связи Заявки	Объект ticketchannel
subject	передает тему Заявки
source	передает по какому Каналу связи была получена Заявка	Объект channel
last_reply	передает последний ответ Агента в Заявке	Объект ticketcomment
last_comment	передает последний Комментарий в Заявке	Объект ticketcomment
issue_count	передает количество связанных Внешних задач
linked_issues	передает связанные Внешние задачи
is_external	передает является ли Заявка Внешней(boolean)	TRUE\|FALSE
parent_ticket	передает родительскую заявку

ticketchannel

Каналы связи Заявки

Параметр	Что делает	Значения
channel	Передает Каналы связи Заявки	Объект channel

ticketcomment

Комментарии Заявки

Параметр	Что делает	Значения
id	передает ID комментария
author	передает Автора комментария	Объект user
created_at	передает дату создания Комментария
body	передает содержимое комментария

ticketissue

Внешние задачи, связанные с Заявкой

Параметр	Что делает	Значения
issue	передает Внешнюю задачу, связанную с Заявкой
author	передает Сотрудника, связавшего/создавшего Внешнюю задачу
ticket	передает саму Заявку

ticketsla

Политики SLA Заявки

Параметр	Что делает	Значения
sla_breach_idx	передает индекс превышения SLA
first_response_time_breach_idx	передает индекс превышения времени первого ответа в Заявке
full_resolution_time_breach_idx	передает индекс превышения полного времени решения Заявки
next_response_time_breach_idx	передает индекс превышения времени между ответами
agent_update_time_breach_idx	передает индекс превышения времени ответа Сотрудника
support_resolution_time_breach_idx	передает индекс превышения времени решения в поддержке
customer_wait_time_breach_idx	передает индекс превышения времени решения без ожидания

user

Пользователи

Параметр	Что делает	Значения
uid	передает UID пользователя
email	передает email Пользователя
name	передает имя Пользователя
role	передает Роль Пользователя	"ADMIN" "MANAGER" "AGENT" "INTERNAL_USER" "CUSTOMER_ADMIN" "CUSTOMER" "BLOCKED"
is_robot	передает является ли Пользователь Роботом(boolean)	TRUE\|FALSE
is_system	передает является ли Пользователь системным пользователем(boolean)	TRUE\|FALSE
is_employee	передает является ли Пользователь Сотрудником(boolean)	TRUE\|FALSE
kcs_role	передает KCS роль Пользователя	"NOT SET" "CANDIDATE" "CONTRIBUTOR" "PUBLISHER"
started_at	Передает дату начала работы Пользователя
dismissed_at	Передает дату увольнения Пользователя
created_at	передает дату создания Пользователя
updated_at	передает дату редактирования Пользователя
aqi_evaluator	передает является ли Пользователь проверяющим Качество Контента	TRUE\|FALSE
lai_evaluator	передает является ли Пользователь проверяющим Точности Связанности	TRUE\|FALSE
qa_evaluator	передает является ли Пользователь проверяющим Качество Сервиса	TRUE\|FALSE
status	передает Статус Пользователя	"OFFLINE" "ONLINE" "IN_SESSION" "WRAPUP" "AWAY" "BUSY"
email_format	передает формат email для Пользователя	"HTML" "TEXT"
timezone	передает таймзону Пользователя
source	передает источник создания Пользователя	"system" "email" "invite" "api" "token" "script" "okdesk" "crm" "telegram" "whatsapp" "vk" "phone" "max"
schedule	передает Расписание Пользователя	Объект schedule
skills	передает Навыки Пользователя	Объект skill
organization	передает Компанию Пользователя	Объект organization
group_memberships	передает список Групп, в которых состоит Пользователь	Объект group

useridentity

Учетные записи Пользователя

Параметр	Что делает	Значения
uid	передает UID Пользователя
user	передает Пользователя, связанного с Учетной Записью	Объект user
ext_id	передает внешний ID Учетной записи
source	передает источник Учетной записи	"EMAIL" "TELEGRAM" "WHATSAPP" "VK" "PHONE" "ANONYMOUS", "MAX"

usersegment

сегменты Пользователей

Параметр	Что делает	Значения
uid	передает UID Сегмента Пользователей
name	передает название Сегмента Пользователей
created_at	передает дату создания Сегмента Пользователей
updated_at	передает дату последнего редактирования Сегмента Пользователей

version

версии Продукта

Параметр	Что делает	Значения
event.version.uid	передает UID версии продукта