Skip to main content

Webhook: TASK_STARTS_SOON

Webhook TASK_STARTS_SOON срабатывает за 15 минут до запланированного начала задачи. Он уведомляет подписчиков, чтобы обеспечить готовность или уведомить назначенных пользователей о предстоящих задачах.

Цель​

Этот webhook предназначен для:

  • Уведомления систем или пользователей заранее о задаче.
  • Улучшения управления задачами и подготовки.
  • Обеспечения возможностей автоматизации через уведомления в реальном времени.

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

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

{
   "entityId": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
   "type": "TASK_STARTS_SOON",
   "createdAt": "2024-12-13T09:45:21.300Z",
   "data": {
      "id": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "seriesId": null,
      "recurrenceRule": null,
      "recurrenceException": null,
      "startAt": "2024-12-13T10:00:00.000Z",
      "endAt": "2024-12-13T11:00:00.000Z",
      "name": "Task 1",
      "priority": "MAJOR",
      "orderStepsRequired": false,
      "strictTimeRequired": false,
      "deadlined": false,
      "published": true,
      "tags": [],
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "externalId": null,
      "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "createdAt": "2024-12-13T09:40:24.224Z",
      "lastModifiedBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "lastModifiedAt": "2024-12-13T09:40:24.224Z",
      "stepId": null,
      "actionId": null
   }
}

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

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

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

Раздел данных​

Содержит подробную информацию о задаче:

  • id: Уникальный идентификатор задачи.
  • organizationId: Идентификатор организации, связанной с задачей.
  • locationId: Идентификатор местоположения задачи.
  • startAt: Время начала задачи в формате ISO 8601.
  • endAt: Время окончания задачи в формате ISO 8601.
  • priority: Уровень приоритета задачи (например, MAJOR).
  • assigneeIds: Список идентификаторов пользователей, назначенных на задачу.
  • createdBy: Идентификатор пользователя, который создал задачу.
  • lastModifiedBy: Идентификатор пользователя, который в последний раз изменил задачу.

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

Успешный ответ повторяет пейлоад запроса и подтверждает его получение:

{
   "entityId": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
   "type": "TASK_STARTS_SOON",
   "createdAt": "2024-12-13T09:45:21.300Z",
   "data": {
      "id": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "seriesId": null,
      "recurrenceRule": null,
      "recurrenceException": null,
      "startAt": "2024-12-13T10:00:00.000Z",
      "endAt": "2024-12-13T11:00:00.000Z",
      "name": "Task 1",
      "priority": "MAJOR",
      "orderStepsRequired": false,
      "strictTimeRequired": false,
      "deadlined": false,
      "published": true,
      "tags": [],
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "externalId": null,
      "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "createdAt": "2024-12-13T09:40:24.224Z",
      "lastModifiedBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "lastModifiedAt": "2024-12-13T09:40:24.224Z",
      "stepId": null,
      "actionId": null
   }
}

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

  • Обеспечивает своевременную подготовку к предстоящим задачам.
  • Поддерживает эффективное планирование и управление ресурсами.
  • Повышает отслеживание задач и готовность команд или систем.