Skip to main content

Webhook: ISSUE_CREATED

Обзор​

Webhook ISSUE_CREATED срабатывает, когда новая проблема успешно создается в системе. Он отправляет уведомление с подробной информацией о проблеме, такой как её название, назначенный пользователь и связанная организация. Это помогает системам и пользователям эффективно отслеживать и управлять новыми проблемами.

Цель​

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

Формат запроса​

Webhook отправляет HTTP POST запрос с следующим JSON-пейлоадом:

{
   "entityId": "decd63dd-50e8-43c5-b467-965402c0575b",
   "type": "ISSUE_CREATED",
   "createdAt": "2024-12-16T12:14:15.029Z",
   "data": {
      "operation": "INSERT",
      "current": {
         "id": "decd63dd-50e8-43c5-b467-965402c0575b",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue 2",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": null
   },
   "id": 201
}

Ключевые свойства​

Верхний уровень​

  • entityId: Уникальный идентификатор проблемы.
  • type: Указывает тип webhook (ISSUE_CREATED).
  • createdAt: Временная метка срабатывания webhook в формате ISO 8601.
  • data: Содержит подробности о вновь созданной проблеме.

Поля данных​

Операция​

  • operation: Описание выполненной операции. Для вновь созданных проблем это всегда INSERT.

Данные текущей (новой) проблемы​

  • id: Уникальный идентификатор проблемы.
  • organizationId: Идентификатор организации, связанной с проблемой.
  • name: Название или заголовок проблемы.
  • assigneeId: Идентификатор пользователя, которому назначена проблема.
  • locationId: Идентификатор местоположения проблемы.
  • createdBy: Идентификатор пользователя, создавшего проблему.

Предыдущие​

  • previous: Данные проблемы до текущей операции. Для новых проблем это поле всегда равно null.

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

Пример пейлоада для успешного срабатывания webhook:

{
   "entityId": "decd63dd-50e8-43c5-b467-965402c0575b",
   "type": "ISSUE_CREATED",
   "createdAt": "2024-12-16T12:14:15.029Z",
   "data": {
      "operation": "INSERT",
      "current": {
         "id": "decd63dd-50e8-43c5-b467-965402c0575b",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue 2",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": null
   }
}

Преимущества​

  1. Уведомления в реальном времени: Системы и пользователи могут немедленно узнать о новых проблемах для своевременного реагирования.
  2. Автоматическая интеграция рабочих процессов: Помогает автоматизировать следующие процессы, такие как назначение задач, уведомления или ведение учёта.
  3. Централизованное отслеживание: Обеспечивает, чтобы все проблемы регистрировались с полными деталями, что упрощает управление проблемами.

Webhook ISSUE_CREATED является важным инструментом для поддержания эффективных рабочих процессов и надёжного управления проблемами.