Документация

Заинтересованные стороны сервиса по умолчанию

Версия v2.3.1 · Обновлено

Заинтересованные стороны сервиса по умолчанию#

Заинтересованные стороны сервиса по умолчанию позволяют определить пользователей, которых следует автоматически добавлять к новым инцидентам сервиса.

Когда для сервиса создаётся новый инцидент, IncidentRelay копирует активных владельцев сервиса в список заинтересованных сторон инцидента. Это снимок: последующее изменение заинтересованных сторон сервиса по умолчанию не перезаписывает существующие инциденты.

Когда используются заинтересованные стороны по умолчанию#

Заинтересованные стороны по умолчанию копируются при создании новой группы алертов / инцидента и сопоставлении её с сервисом.

Они полезны для:

  • владельцев сервиса;
  • бизнес-владельцев;
  • контактов поддержки;
  • контактов по работе с клиентами (customer success);
  • руководителей или других наблюдателей.

Как это работает#

У сервиса может быть одна или несколько заинтересованных сторон по умолчанию.

Каждая заинтересованная сторона по умолчанию хранится в сервисе как запись владельца сервиса. Когда IncidentRelay создаёт новый инцидент для этого сервиса, активные владельцы сервиса копируются в список заинтересованных сторон инцидента.

После копирования у инцидента появляется собственный снимок заинтересованных сторон.

Это означает:

  • новые заинтересованные стороны сервиса по умолчанию влияют только на новые инциденты;
  • отключённые заинтересованные стороны сервиса по умолчанию не копируются в новые инциденты;
  • существующие инциденты не изменяются при редактировании значений сервиса по умолчанию;
  • заинтересованных сторон инцидента по-прежнему можно редактировать непосредственно в инциденте.

Поддерживаемые роли#

Поле роли описывает, почему пользователь добавлен к инциденту.

Распространённые роли:

РольОписание
ownerТехнический или операционный владелец
stakeholderОбщая заинтересованная сторона
business_ownerБизнес-владелец
supportКонтакт поддержки
customer_successКонтакт по работе с клиентами
executiveНаблюдатель из руководства
customПользовательская роль

Роль копируется в запись заинтересованной стороны инцидента.

Параметры уведомлений#

У каждой заинтересованной стороны по умолчанию есть флаги уведомлений.

ФлагСобытие
notify_on_createdСоздан новый инцидент
notify_on_priority_changeИзменён приоритет инцидента
notify_on_status_changeИнцидент подтверждён или изменён его статус
notify_on_resolvedИнцидент разрешён

Эти флаги копируются в снимок заинтересованной стороны инцидента вместе с пользователем и ролью.

Каналы уведомлений#

Уведомления заинтересованным сторонам отправляются через:

  • email, если у заинтересованной стороны есть адрес электронной почты;
  • браузерные push-уведомления, если заинтересованная сторона является активным пользователем IncidentRelay с включёнными браузерными push-уведомлениями.

Браузерные push-уведомления для заинтересованных сторон носят информационный характер. Они не содержат кнопок ACK, Resolve, Shelve или Unshelve.

Внешние заинтересованные стороны без учётной записи пользователя IncidentRelay могут получать только уведомления по email.

События жизненного цикла инцидента#

Заинтересованные стороны по умолчанию могут получать уведомления о следующих событиях жизненного цикла.

Создан новый инцидент#

Когда для сервиса создаётся новая группа алертов, IncidentRelay копирует активных владельцев сервиса в заинтересованные стороны инцидента.

Если включён notify_on_created, заинтересованная сторона получает email и, при наличии возможности, браузерное push-уведомление.

Изменён приоритет#

Когда приоритет инцидента изменяется вручную, уведомляются заинтересованные стороны с включённым notify_on_priority_change.

Уведомление содержит старый и новый приоритет.

Изменён статус#

Когда инцидент подтверждается или изменяется его статус, уведомляются заинтересованные стороны с включённым notify_on_status_change.

Ручное подтверждение отправляет уведомление об изменении статуса.

Инцидент разрешён#

Когда инцидент разрешается вручную или входящим payload'ом о разрешении от интеграции, уведомляются заинтересованные стороны с включённым notify_on_resolved.

Повторные payload'ы о разрешении не отправляют дублирующих уведомлений заинтересованным сторонам, если инцидент уже был разрешён.

Существующие инциденты#

Изменения заинтересованных сторон по умолчанию влияют только на новые инциденты.

Существующие инциденты сохраняют собственный снимок заинтересованных сторон. Чтобы изменить заинтересованные стороны для существующего инцидента, отредактируйте список заинтересованных сторон инцидента напрямую.

API#

Получить список заинтересованных сторон сервиса по умолчанию#

GET /api/services/<service_id>/owners

Возвращает заинтересованные стороны по умолчанию, настроенные для сервиса.

Создать заинтересованную сторону сервиса по умолчанию#

POST /api/services/<service_id>/owners

Пример запроса:

{
  "user_id": 42,
  "role": "business_owner",
  "active": true,
  "notify_on_created": true,
  "notify_on_priority_change": true,
  "notify_on_status_change": false,
  "notify_on_resolved": true
}

Обновить заинтересованную сторону сервиса по умолчанию#

PUT /api/services/<service_id>/owners/<owner_id>

Пример запроса:

{
  "user_id": 42,
  "role": "support",
  "active": true,
  "notify_on_created": true,
  "notify_on_priority_change": false,
  "notify_on_status_change": true,
  "notify_on_resolved": true
}

Деактивировать заинтересованную сторону сервиса по умолчанию#

DELETE /api/services/<service_id>/owners/<owner_id>

Эндпоинт удаления деактивирует заинтересованную сторону по умолчанию. Существующие заинтересованные стороны инцидента не изменяются.

Пример ответа:

{
  "deleted": true,
  "id": 10
}