incident.io — учёт инцидентов: создание карточки, действия, follow-up (последующая задача после инцидента), расписания дежурств и эскалации.
С incident.io в Pailot вы можете:
- Смотреть, создавать и обновлять инциденты (нужен idempotency_key)
- Читать действия и follow-up, пользователей, статусы, типы и уровни серьёзности
- Настраивать workflow, расписания, эскалации и пользовательские поля
- Смотреть роли, временные метки и обновления инцидента
Нужен ключ API (Application Programming Interface — программный интерфейс) incident.io.
Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.
Список инцидентов: серьёзность, статус и время.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
page_size | number | Нет | Число инцидентов на страницу (по умолчанию 25) |
after | string | Нет | Курсор следующей страницы |
| Параметр | Тип | Описание |
|---|
incidents | array | Список инцидентов |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ summary | string | Краткое описание инцидента |
↳ description | string | Подробное описание инцидента |
↳ mode | string | Incident mode (например standard, retrospective) |
↳ call_url | string | URL инцидента call/bridge |
↳ severity | object | Серьёзность инцидента |
↳ id | string | ID серьёзности |
↳ name | string | Название серьёзности |
↳ rank | number | Ранг серьёзности |
↳ rank | number | Ранг серьёзности |
↳ status | object | Текущий статус инцидента |
↳ id | string | ID статуса |
↳ name | string | Название статуса |
↳ category | string | Категория статуса |
↳ category | string | Категория статуса |
↳ incident_type | object | Тип инцидента |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_url | string | URL инцидента |
↳ slack_channel_id | string | ID связанного канала Slack |
↳ slack_channel_name | string | Имя связанного канала Slack |
↳ visibility | string | Видимость инцидента |
pagination_meta | object | Метаданные постраничного вывода |
↳ after | string | Курсор следующей страницы |
↳ page_size | number | Число элементов на страницу |
↳ total_record_count | number | Всего records available |
Создать инцидент в incident.io. Обязательны idempotency_key, severity_id и visibility. Необязательно: name, summary, type и status.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
idempotency_key | string | Да | Уникальный ключ, чтобы не создать инцидент дважды. UUID или уникальная строка. |
name | string | Нет | Имя инцидента (необязательно) |
summary | string | Нет | Краткое описание инцидента |
severity_id | string | Да | ID серьёзность |
incident_type_id | string | Нет | ID инцидент |
incident_status_id | string | Нет | ID инцидент |
visibility | string | Да | Видимость инцидента: public или private (обязательно) |
| Параметр | Тип | Описание |
|---|
incident | object | Созданный инцидент |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ summary | string | Краткое описание инцидента |
↳ description | string | Подробное описание инцидента |
↳ mode | string | Incident mode (например standard, retrospective) |
↳ call_url | string | URL инцидента call/bridge |
↳ severity | object | Серьёзность инцидента |
↳ id | string | ID серьёзности |
↳ name | string | Название серьёзности |
↳ rank | number | Ранг серьёзности |
↳ rank | number | Ранг серьёзности |
↳ status | object | Текущий статус инцидента |
↳ id | string | ID статуса |
↳ name | string | Название статуса |
↳ category | string | Категория статуса |
↳ category | string | Категория статуса |
↳ incident_type | object | Тип инцидента |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_url | string | URL инцидента |
↳ slack_channel_id | string | ID связанного канала Slack |
↳ slack_channel_name | string | Имя связанного канала Slack |
↳ visibility | string | Видимость инцидента |
Подробности инцидента по ID. Полная карточка: пользовательские поля и роли.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID инцидент |
| Параметр | Тип | Описание |
|---|
incident | object | Подробные данные инцидента |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ summary | string | Краткое описание инцидента |
↳ description | string | Подробное описание инцидента |
↳ mode | string | Incident mode (например standard, retrospective) |
↳ call_url | string | URL инцидента call/bridge |
↳ permalink | string | Постоянная ссылка на инцидент |
↳ severity | object | Серьёзность инцидента |
↳ id | string | ID серьёзности |
↳ name | string | Название серьёзности |
↳ rank | number | Ранг серьёзности |
↳ rank | number | Ранг серьёзности |
↳ status | object | Текущий статус инцидента |
↳ id | string | ID статуса |
↳ name | string | Название статуса |
↳ category | string | Категория статуса |
↳ category | string | Категория статуса |
↳ incident_type | object | Тип инцидента |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_url | string | URL инцидента |
↳ slack_channel_id | string | ID связанного канала Slack |
↳ slack_channel_name | string | Имя связанного канала Slack |
↳ visibility | string | Видимость инцидента |
↳ custom_field_entries | array | Значения пользовательских полей инцидента |
↳ incident_role_assignments | array | Role assignments инцидента |
Обновить инцидент в incident.io. Можно менять name, summary, severity, status или type.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID инцидент |
name | string | Нет | Обновлённое имя инцидента |
summary | string | Нет | Обновлённое краткое описание инцидента |
severity_id | string | Нет | Updated severity ID инцидента |
incident_status_id | string | Нет | Новый ID статуса инцидента |
incident_type_id | string | Нет | ID обновлённого типа инцидента |
notify_incident_channel | boolean | Да | Уведомлять ли канал инцидента об этом обновлении |
| Параметр | Тип | Описание |
|---|
incident | object | Обновлённый инцидент |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ summary | string | Краткое описание инцидента |
↳ description | string | Подробное описание инцидента |
↳ mode | string | Incident mode (например standard, retrospective) |
↳ call_url | string | URL инцидента call/bridge |
↳ severity | object | Серьёзность инцидента |
↳ id | string | ID серьёзности |
↳ name | string | Название серьёзности |
↳ rank | number | Ранг серьёзности |
↳ rank | number | Ранг серьёзности |
↳ status | object | Текущий статус инцидента |
↳ id | string | ID статуса |
↳ name | string | Название статуса |
↳ category | string | Категория статуса |
↳ category | string | Категория статуса |
↳ incident_type | object | Тип инцидента |
↳ id | string | ID типа |
↳ name | string | Название типа |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_url | string | URL инцидента |
↳ slack_channel_id | string | ID связанного канала Slack |
↳ slack_channel_name | string | Имя связанного канала Slack |
↳ visibility | string | Видимость инцидента |
Список действий. Необязательный фильтр по ID инцидента.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
incident_id | string | Нет | Фильтр действий по ID инцидента |
page_size | number | Нет | Число действий на страницу |
| Параметр | Тип | Описание |
|---|
actions | array | Список действий |
↳ id | string | ID пользователя |
↳ description | string | Описание действия |
↳ assignee | object | Назначенный пользователь |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ status | string | Статус действия |
↳ due_at | string | Срок |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_id | string | ID связанного инцидента |
↳ creator | object | Кто создал действие |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ completed_at | string | Время завершения |
↳ external_issue_reference | object | Ссылка на внешнюю систему учёта задач |
↳ provider | string | Система учёта задач (например Jira, Linear) |
↳ issue_name | string | Идентификатор задачи |
↳ issue_permalink | string | URL внешней задачи |
↳ provider | string | Система учёта задач (например Jira, Linear) |
↳ issue_name | string | Идентификатор задачи |
↳ issue_permalink | string | URL внешней задачи |
Подробности действия в incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID действия |
| Параметр | Тип | Описание |
|---|
action | object | Детали действия |
↳ id | string | ID пользователя |
↳ description | string | Описание действия |
↳ assignee | object | Назначенный пользователь |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ status | string | Статус действия |
↳ due_at | string | Срок |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_id | string | ID связанного инцидента |
↳ creator | object | Кто создал действие |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ completed_at | string | Время завершения |
↳ external_issue_reference | object | Ссылка на внешнюю систему учёта задач |
↳ provider | string | Система учёта задач (например Jira, Linear) |
↳ issue_name | string | Идентификатор задачи |
↳ issue_permalink | string | URL внешней задачи |
↳ provider | string | Система учёта задач (например Jira, Linear) |
↳ issue_name | string | Идентификатор задачи |
↳ issue_permalink | string | URL внешней задачи |
Список follow-up. Необязательный фильтр по ID инцидента.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
incident_id | string | Нет | Фильтр follow-up по ID инцидента |
page_size | number | Нет | Число follow-up на страницу |
| Параметр | Тип | Описание |
|---|
follow_ups | array | Список follow-up |
↳ id | string | ID пользователя |
↳ title | string | Заголовок follow-up |
↳ description | string | Описание приоритета |
↳ assignee | object | Назначенный пользователь |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ status | string | Статус follow-up |
↳ priority | object | Приоритет follow-up |
↳ id | string | ID приоритета |
↳ name | string | Название приоритета |
↳ description | string | Описание приоритета |
↳ rank | number | Ранг приоритета |
↳ rank | number | Ранг приоритета |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_id | string | ID связанного инцидента |
↳ creator | object | Кто создал follow-up |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ completed_at | string | Время завершения |
↳ labels | array | Метки follow-up |
↳ external_issue_reference | object | Ссылка на внешнюю систему учёта задач |
↳ provider | string | Имя внешнего провайдера |
↳ issue_name | string | Имя или ID внешней задачи |
↳ issue_permalink | string | Постоянная ссылка на внешнюю задачу |
↳ provider | string | Имя внешнего провайдера |
↳ issue_name | string | Имя или ID внешней задачи |
↳ issue_permalink | string | Постоянная ссылка на внешнюю задачу |
Подробности follow-up в incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID follow-up |
| Параметр | Тип | Описание |
|---|
follow_up | object | Детали follow-up |
↳ id | string | ID пользователя |
↳ title | string | Заголовок follow-up |
↳ description | string | Описание приоритета |
↳ assignee | object | Назначенный пользователь |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ status | string | Статус follow-up |
↳ priority | object | Приоритет follow-up |
↳ id | string | ID приоритета |
↳ name | string | Название приоритета |
↳ description | string | Описание приоритета |
↳ rank | number | Ранг приоритета |
↳ rank | number | Ранг приоритета |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
↳ incident_id | string | ID связанного инцидента |
↳ creator | object | Кто создал follow-up |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ completed_at | string | Время завершения |
↳ labels | array | Метки follow-up |
↳ external_issue_reference | object | Ссылка на внешнюю систему учёта задач |
↳ provider | string | Имя внешнего провайдера |
↳ issue_name | string | Имя или ID внешней задачи |
↳ issue_permalink | string | Постоянная ссылка на внешнюю задачу |
↳ provider | string | Имя внешнего провайдера |
↳ issue_name | string | Имя или ID внешней задачи |
↳ issue_permalink | string | Постоянная ссылка на внешнюю задачу |
Список пользователей рабочего пространства incident.io. Данные пользователя: id, name, email и role.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
page_size | number | Нет | Число результатов на страницу (по умолчанию 25) |
| Параметр | Тип | Описание |
|---|
users | array | Пользователи workspace |
↳ id | string | Уникальный идентификатор пользователя |
↳ name | string | Полное имя пользователя |
↳ email | string | Email пользователя |
↳ role | string | Роль пользователя в workspace |
Карточка пользователя рабочего пространства incident.io по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID пользователя |
| Параметр | Тип | Описание |
|---|
user | object | Данные запрошенного пользователя |
↳ id | string | Уникальный идентификатор пользователя |
↳ name | string | Полное имя пользователя |
↳ email | string | Email пользователя |
↳ role | string | Роль пользователя в workspace |
Список всех workflow в рабочем пространстве incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
page_size | number | Нет | Число workflow на страницу |
after | string | Нет | Курсор следующей страницы |
| Параметр | Тип | Описание |
|---|
workflows | array | Список workflow |
↳ id | string | Уникальный идентификатор workflow |
↳ name | string | Имя workflow |
↳ state | string | Состояние workflow: active, draft или disabled |
↳ folder | string | Папка workflow |
↳ created_at | string | Когда создан workflow |
↳ updated_at | string | Когда workflow обновляли в последний раз |
pagination_meta | object | Метаданные постраничного вывода |
↳ after | string | Курсор следующей страницы |
↳ page_size | number | Результатов на страницу |
Карточка workflow в incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID workflow |
| Параметр | Тип | Описание |
|---|
workflow | object | Детали workflow |
↳ id | string | Уникальный идентификатор workflow |
↳ name | string | Имя workflow |
↳ state | string | Состояние workflow: active, draft или disabled |
↳ folder | string | Папка workflow |
↳ created_at | string | Когда создан workflow |
↳ updated_at | string | Когда workflow обновляли в последний раз |
Обновить workflow в incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID workflow для обновления |
name | string | Нет | Новое имя workflow |
state | string | Нет | Новое состояние workflow: active, draft или disabled |
folder | string | Нет | Новая папка workflow |
| Параметр | Тип | Описание |
|---|
workflow | object | Обновлённый workflow |
↳ id | string | Уникальный идентификатор workflow |
↳ name | string | Имя workflow |
↳ state | string | Состояние workflow: active, draft или disabled |
↳ folder | string | Папка workflow |
↳ created_at | string | Когда создан workflow |
↳ updated_at | string | Когда workflow обновляли в последний раз |
Удалить workflow в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID workflow для удаления |
| Параметр | Тип | Описание |
|---|
message | string | Сообщение об успехе |
Список всех расписаний в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
page_size | number | Нет | Результатов на страницу (по умолчанию: 25) |
after | string | Нет | Курсор следующей страницы |
| Параметр | Тип | Описание |
|---|
schedules | array | Список расписаний |
↳ id | string | ID расписания |
↳ name | string | Имя расписания |
↳ timezone | string | Часовой пояс расписания |
↳ created_at | string | Когда создано расписание |
↳ updated_at | string | Когда расписание обновляли в последний раз |
pagination_meta | object | Метаданные постраничного вывода |
↳ after | string | Курсор следующей страницы |
↳ page_size | number | Результатов на страницу |
Создать расписание в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
name | string | Да | Имя расписания |
timezone | string | Да | Часовой пояс расписания (например America/New_York) |
config | string | Да | Конфигурация расписания как JSON-строка с ротациями. Пример: {"rotations": [{"name": "Primary", "users": [{"id": "user_id"}], "handover_start_at": "2024-01-01T09:00:00Z", "handovers": [{"interval": 1, "interval_type": "weekly"}]}]} |
Example | string | Нет | Нет описания |
| Параметр | Тип | Описание |
|---|
schedule | object | Созданное расписание |
↳ id | string | ID расписания |
↳ name | string | Имя расписания |
↳ timezone | string | Часовой пояс расписания |
↳ created_at | string | Когда создано расписание |
↳ updated_at | string | Когда расписание обновляли в последний раз |
Карточка расписания в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID расписания |
| Параметр | Тип | Описание |
|---|
schedule | object | Детали расписания |
↳ id | string | ID расписания |
↳ name | string | Имя расписания |
↳ timezone | string | Часовой пояс расписания |
↳ created_at | string | Когда создано расписание |
↳ updated_at | string | Когда расписание обновляли в последний раз |
Обновить расписание в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID расписания для обновления |
name | string | Нет | Новое имя расписания |
timezone | string | Нет | Новый часовой пояс расписания (например America/New_York) |
config | string | Нет | Конфигурация расписания как JSON-строка с ротациями. Пример: {"rotations": [{"name": "Primary", "users": [{"id": "user_id"}], "handover_start_at": "2024-01-01T09:00:00Z", "handovers": [{"interval": 1, "interval_type": "weekly"}]}]} |
Example | string | Нет | Нет описания |
| Параметр | Тип | Описание |
|---|
schedule | object | Обновлённое расписание |
↳ id | string | ID расписания |
↳ name | string | Имя расписания |
↳ timezone | string | Часовой пояс расписания |
↳ created_at | string | Когда создано расписание |
↳ updated_at | string | Когда расписание обновляли в последний раз |
Удалить расписание в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID расписания для удаления |
| Параметр | Тип | Описание |
|---|
message | string | Сообщение об успехе |
Список политик эскалации в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
page_size | number | Нет | Результатов на страницу (по умолчанию: 25) |
| Параметр | Тип | Описание |
|---|
escalations | array | Политики эскалации |
↳ id | string | ID эскалация |
↳ name | string | Имя политики эскалации |
↳ created_at | string | Когда создана политика эскалации |
↳ updated_at | string | Когда политику эскалации обновляли в последний раз |
Создать политику эскалации в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
idempotency_key | string | Да | Уникальный ключ, чтобы не создать эскалацию дважды. UUID или уникальная строка. |
title | string | Да | Заголовок эскалации |
escalation_path_id | string | Нет | ID эскалация |
user_ids | string | Нет | ID пользователей для уведомления через запятую (обязательно, если не задан escalation_path_id) |
| Параметр | Тип | Описание |
|---|
escalation | object | Созданная политика эскалации |
↳ id | string | ID эскалация |
↳ name | string | Имя политики эскалации |
↳ created_at | string | Когда создана политика эскалации |
↳ updated_at | string | Когда политику эскалации обновляли в последний раз |
Карточка политики эскалации в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID политики эскалации |
| Параметр | Тип | Описание |
|---|
escalation | object | Детали политики эскалации |
↳ id | string | ID эскалация |
↳ name | string | Имя политики эскалации |
↳ created_at | string | Когда создана политика эскалации |
↳ updated_at | string | Когда политику эскалации обновляли в последний раз |
Список пользовательских полей incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
| Параметр | Тип | Описание |
|---|
custom_fields | array | Пользовательские поля |
↳ id | string | ID пользовательского поля |
↳ name | string | Название пользовательского поля |
↳ description | string | Описание пользовательского поля |
↳ field_type | string | Тип пользовательского поля |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
Создать пользовательское поле в incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
name | string | Да | Название пользовательского поля |
description | string | Да | Описание пользовательского поля (обязательно) |
field_type | string | Да | Тип пользовательского поля (например text, single_select, multi_select, numeric, datetime, link, user, team) |
| Параметр | Тип | Описание |
|---|
custom_field | object | Созданное пользовательское поле |
↳ id | string | ID пользовательского поля |
↳ name | string | Название пользовательского поля |
↳ description | string | Описание пользовательского поля |
↳ field_type | string | Тип пользовательского поля |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
Подробности пользовательского поля incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID пользовательского поля |
| Параметр | Тип | Описание |
|---|
custom_field | object | Детали пользовательского поля |
↳ id | string | ID пользовательского поля |
↳ name | string | Название пользовательского поля |
↳ description | string | Описание пользовательского поля |
↳ field_type | string | Тип пользовательского поля |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
Обновить пользовательское поле в incident.io.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID пользовательского поля |
name | string | Да | Новое имя пользовательского поля (обязательно) |
description | string | Да | Новое описание пользовательского поля (обязательно) |
| Параметр | Тип | Описание |
|---|
custom_field | object | Обновлённое пользовательское поле |
↳ id | string | ID пользовательского поля |
↳ name | string | Название пользовательского поля |
↳ description | string | Описание пользовательского поля |
↳ field_type | string | Тип пользовательского поля |
↳ created_at | string | Время создания |
↳ updated_at | string | Время последнего обновления |
Удалить пользовательское поле incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID пользовательского поля |
| Параметр | Тип | Описание |
|---|
message | string | Сообщение об успехе |
Список уровней серьёзности в рабочем пространстве incident.io. Данные серьёзности: id, name, description и rank.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
| Параметр | Тип | Описание |
|---|
severities | array | Уровни серьёзности |
↳ id | string | Уникальный идентификатор уровня серьёзности |
↳ name | string | Название уровня серьёзности |
↳ description | string | Описание уровня серьёзности |
↳ rank | number | Ранг уровня серьёзности |
Список статусов инцидента в рабочем пространстве incident.io. Данные статуса: id, name, description и category.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
| Параметр | Тип | Описание |
|---|
incident_statuses | array | Статусы инцидентов |
↳ id | string | Уникальный идентификатор статуса инцидента |
↳ name | string | Название статуса инцидента |
↳ description | string | Описание статуса инцидента |
↳ category | string | Категория статуса инцидента |
Список типов инцидента в рабочем пространстве incident.io. Данные типа: id, name, description и флаг default.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
| Параметр | Тип | Описание |
|---|
incident_types | array | Типы инцидентов |
↳ id | string | Уникальный идентификатор типа инцидента |
↳ name | string | Название типа инцидента |
↳ description | string | Описание типа инцидента |
↳ is_default | boolean | Тип инцидента по умолчанию |
Список ролей инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
| Параметр | Тип | Описание |
|---|
incident_roles | array | Роли инцидента |
↳ id | string | ID инцидент |
↳ name | string | Имя роли в инциденте |
↳ description | string | Описание роли в инциденте |
↳ instructions | string | Инструкции для роли |
↳ shortform | string | Краткое обозначение роли |
↳ role_type | string | Тип роли |
↳ required | boolean | Обязательна ли роль |
↳ created_at | string | Когда создана роль |
↳ updated_at | string | Когда роль обновляли в последний раз |
Создать роль инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
name | string | Да | Название роли в инциденте |
description | string | Да | Описание роли в инциденте |
instructions | string | Да | Instructions инцидента role |
shortform | string | Да | Краткое обозначение роли |
| Параметр | Тип | Описание |
|---|
incident_role | object | Созданная роль инцидента |
↳ id | string | ID инцидент |
↳ name | string | Имя роли в инциденте |
↳ description | string | Описание роли в инциденте |
↳ instructions | string | Инструкции для роли |
↳ shortform | string | Краткое обозначение роли |
↳ role_type | string | Тип роли |
↳ required | boolean | Обязательна ли роль |
↳ created_at | string | Когда создана роль |
↳ updated_at | string | Когда роль обновляли в последний раз |
Карточка роли инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID роли инцидента |
| Параметр | Тип | Описание |
|---|
incident_role | object | Детали роли в инциденте |
↳ id | string | ID инцидент |
↳ name | string | Имя роли в инциденте |
↳ description | string | Описание роли в инциденте |
↳ instructions | string | Инструкции для роли |
↳ shortform | string | Краткое обозначение роли |
↳ role_type | string | Тип роли |
↳ required | boolean | Обязательна ли роль |
↳ created_at | string | Когда создана роль |
↳ updated_at | string | Когда роль обновляли в последний раз |
Обновить роль инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID роли инцидента для обновления |
name | string | Да | Название роли в инциденте |
description | string | Да | Описание роли в инциденте |
instructions | string | Да | Instructions инцидента role |
shortform | string | Да | Краткое обозначение роли |
| Параметр | Тип | Описание |
|---|
incident_role | object | Обновлённая роль инцидента |
↳ id | string | ID инцидент |
↳ name | string | Имя роли в инциденте |
↳ description | string | Описание роли в инциденте |
↳ instructions | string | Инструкции для роли |
↳ shortform | string | Краткое обозначение роли |
↳ role_type | string | Тип роли |
↳ required | boolean | Обязательна ли роль |
↳ created_at | string | Когда создана роль |
↳ updated_at | string | Когда роль обновляли в последний раз |
Удалить роль инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID роли инцидента для удаления |
| Параметр | Тип | Описание |
|---|
message | string | Сообщение об успехе |
Список определений временных меток инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
| Параметр | Тип | Описание |
|---|
incident_timestamps | array | Определения временных меток инцидента |
↳ id | string | ID временной метки |
↳ name | string | Имя временной метки |
↳ rank | number | Порядок временной метки |
↳ created_at | string | Когда создана временная метка |
↳ updated_at | string | Когда метку времени обновляли в последний раз |
Карточка определения временной метки инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID временной метки инцидента |
| Параметр | Тип | Описание |
|---|
incident_timestamp | object | Детали временной метки инцидента |
↳ id | string | ID временной метки |
↳ name | string | Имя временной метки |
↳ rank | number | Порядок временной метки |
↳ created_at | string | Когда создана временная метка |
↳ updated_at | string | Когда метку времени обновляли в последний раз |
Список обновлений конкретного инцидента в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
incident_id | string | Нет | ID инцидента для обновлений (необязательно; если не задано — все обновления) |
page_size | number | Нет | Число результатов на страницу |
after | string | Нет | Курсор постраничного вывода |
| Параметр | Тип | Описание |
|---|
incident_updates | array | Обновления инцидента |
↳ id | string | ID пользователя |
↳ incident_id | string | ID инцидента |
↳ message | string | Текст обновления |
↳ new_severity | object | Новая серьёзность, если меняется |
↳ id | string | ID серьёзности |
↳ name | string | Название серьёзности |
↳ rank | number | Ранг серьёзности |
↳ name | string | Имя пользователя |
↳ rank | number | Ранг серьёзности |
↳ new_status | object | Новый статус, если меняется |
↳ id | string | ID статуса |
↳ name | string | Название статуса |
↳ category | string | Категория статуса |
↳ category | string | Категория статуса |
↳ updater | object | Кто создал обновление |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ email | string | Email пользователя |
↳ created_at | string | Когда создано обновление |
↳ updated_at | string | Когда обновление меняли в последний раз |
pagination_meta | object | Данные постраничного вывода |
↳ after | string | Курсор следующей страницы |
↳ page_size | number | Результатов на страницу |
Список записей конкретного расписания в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
schedule_id | string | Да | ID расписания для записей |
entry_window_start | string | Нет | Начало периода записей (ISO 8601) |
entry_window_end | string | Нет | Конец периода записей (ISO 8601) |
page_size | number | Нет | Число результатов на страницу |
after | string | Нет | Курсор постраничного вывода |
| Параметр | Тип | Описание |
|---|
schedule_entries | array | Записи расписания |
↳ id | string | ID пользователя |
↳ schedule_id | string | ID расписания |
↳ user | object | Пользователь этой записи |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ start_at | string | Когда начинается запись |
↳ end_at | string | Когда запись заканчивается |
↳ layer_id | string | ID расписание |
↳ created_at | string | Когда создана запись |
↳ updated_at | string | Когда запись обновляли в последний раз |
pagination_meta | object | Данные постраничного вывода |
↳ after | string | Курсор следующей страницы |
↳ after_url | string | URL следующей страницы |
↳ page_size | number | Результатов на страницу |
Создать переопределение расписания в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
rotation_id | string | Да | ID ротации для переопределения |
schedule_id | string | Да | ID расписания |
user_id | string | Нет | ID назначаемого (одно из: user_id, user_email, user_slack_id) |
user_email | string | Нет | Email назначаемого (одно из: user_id, user_email, user_slack_id) |
user_slack_id | string | Нет | Slack ID назначаемого (одно из: user_id, user_email, user_slack_id) |
start_at | string | Да | Начало переопределения (ISO 8601) |
end_at | string | Да | Конец переопределения (ISO 8601) |
| Параметр | Тип | Описание |
|---|
override | object | Созданное переопределение расписания |
↳ id | string | ID пользователя |
↳ rotation_id | string | ID ротации |
↳ schedule_id | string | ID расписания |
↳ user | object | Пользователь этого переопределения |
↳ id | string | ID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ start_at | string | Когда начинается переопределение |
↳ end_at | string | Когда заканчивается переопределение |
↳ created_at | string | Когда создано переопределение |
↳ updated_at | string | Когда переопределение обновляли в последний раз |
Создать путь эскалации в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
name | string | Да | Имя пути эскалации |
path | json | Да | Массив уровней эскалации с целями и временем подтверждения в секундах. У каждого уровня: targets (массив {id, type, schedule_id?, user_id?, urgency}) и time_to_ack_seconds (число) |
working_hours | json | Нет | Необязательная конфигурация рабочих часов. Массив {weekday, start_time, end_time} |
| Параметр | Тип | Описание |
|---|
escalation_path | object | Созданный путь эскалации |
↳ id | string | ID цели |
↳ name | string | Имя пути эскалации |
↳ path | array | Массив уровней эскалации |
↳ targets | array | Цели этого уровня |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ time_to_ack_seconds | number | Время на подтверждение в секундах |
↳ targets | array | Цели этого уровня |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ time_to_ack_seconds | number | Время на подтверждение в секундах |
↳ working_hours | array | Настройка рабочих часов |
↳ weekday | string | День недели |
↳ start_time | string | Время начала |
↳ end_time | string | Время окончания |
↳ weekday | string | День недели |
↳ start_time | string | Время начала |
↳ end_time | string | Время окончания |
↳ created_at | string | Когда создан путь |
↳ updated_at | string | Когда путь обновляли в последний раз |
Карточка пути эскалации в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID пути эскалации |
| Параметр | Тип | Описание |
|---|
escalation_path | object | Детали пути эскалации |
↳ id | string | ID цели |
↳ name | string | Имя пути эскалации |
↳ path | array | Массив уровней эскалации |
↳ targets | array | Цели этого уровня |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ time_to_ack_seconds | number | Время на подтверждение в секундах |
↳ targets | array | Цели этого уровня |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ time_to_ack_seconds | number | Время на подтверждение в секундах |
↳ working_hours | array | Настройка рабочих часов |
↳ weekday | string | День недели |
↳ start_time | string | Время начала |
↳ end_time | string | Время окончания |
↳ weekday | string | День недели |
↳ start_time | string | Время начала |
↳ end_time | string | Время окончания |
↳ created_at | string | Когда создан путь |
↳ updated_at | string | Когда путь обновляли в последний раз |
Обновить путь эскалации в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID пути эскалации для обновления |
name | string | Нет | Новое имя пути эскалации |
path | json | Нет | Новая конфигурация пути эскалации. Массив уровней с targets и time_to_ack_seconds |
working_hours | json | Нет | Новая конфигурация рабочих часов. Массив {weekday, start_time, end_time} |
| Параметр | Тип | Описание |
|---|
escalation_path | object | Обновлённый путь эскалации |
↳ id | string | ID цели |
↳ name | string | Имя пути эскалации |
↳ path | array | Массив уровней эскалации |
↳ targets | array | Цели этого уровня |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ time_to_ack_seconds | number | Время на подтверждение в секундах |
↳ targets | array | Цели этого уровня |
↳ id | string | ID цели |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ type | string | Тип цели |
↳ schedule_id | string | ID расписания, если тип — schedule |
↳ user_id | string | ID пользователя, если тип — user |
↳ urgency | string | Уровень срочности |
↳ time_to_ack_seconds | number | Время на подтверждение в секундах |
↳ working_hours | array | Настройка рабочих часов |
↳ weekday | string | День недели |
↳ start_time | string | Время начала |
↳ end_time | string | Время окончания |
↳ weekday | string | День недели |
↳ start_time | string | Время начала |
↳ end_time | string | Время окончания |
↳ created_at | string | Когда создан путь |
↳ updated_at | string | Когда путь обновляли в последний раз |
Удалить путь эскалации в incident.io
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Ключ API incident.io |
id | string | Да | ID пути эскалации для удаления |
| Параметр | Тип | Описание |
|---|
message | string | Сообщение об успехе |
