Skip to main content

Webhook: TASK_CREATED

Описание​

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

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

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

{
   "entityId": "1d63907b-93ed-4188-8b5d-99292fceaae9",
   "type": "TASK_CREATED",
   "createdAt": "2024-12-16T10:00:00.000Z",
   "data": {
      "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T11:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Task 1",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null
   }
}

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

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

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

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

  • id: Уникальный идентификатор задачи.
  • organizationId: Идентификатор организации, связанной с задачей.
  • locationId: Местоположение, где назначена задача.
  • startAt: Время начала задачи в формате ISO 8601.
  • endAt: Время завершения задачи в формате ISO 8601.
  • name: Название или заголовок задачи.
  • assigneeIds: Массив идентификаторов пользователей, назначенных на задачу.
  • recurrenceRule: Детали повторения задачи (если применимо).

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

Пример пейлоада, подтверждающего создание новой задачи:

{
   "entityId": "1d63907b-93ed-4188-8b5d-99292fceaae9",
   "type": "TASK_CREATED",
   "createdAt": "2024-12-16T10:00:00.000Z",
   "data": {
      "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T11:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Task 1",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null
   },
   "id": 101
}

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

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

Используя webhook TASK_CREATED, системы и пользователи могут поддерживать актуальность информации о задачах и эффективно автоматизировать процессы.