Инструкции пользователя

📤 Webhooks

Создание Webhook

Данные о событии

Webhooks (или веб хуки, далее “хуки”) - это механизм обратной связи от Yonote к вашему приложению.

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

Отправка веб-хуков производится только для протокола HTTPS

Если приложение в ответ на событие отвечает кодом, отличным от HTTP 200, Yonote предпримет еще несколько попыток отправки.

Если дополнительные попытки завершатся с ошибкой, Yonote автоматически отключит неработающий веб-хук. (Вы сможете включить заново, когда проблемы будут устранены)

Создание Webhook

Перейдите в раздел Настройки → Webhooks

Создайте новый хук используя кнопку “Новый webhook”

Галочками выберете необходимые Вашему приложению события и сохраните вебхук

Данные о событии

При наступлении события, на указанный в настройках хука адрес будет отправлен POST запрос JSON данными. Далее пример события обновления документа:

{
  "id": "80a6a912-0ea5-43ba-921f-48ed3379195d",
  "actorId": "dba19bd7-a3d5-4ae4-af67-561048029d82",
  "webhookSubscriptionId": "b72438aa-19a3-4ffc-90f8-d5f32ceb1ac0",
  "createdAt": "2022-07-18T13:24:40.304Z",
  "event": "documents.update", // Название события
  "payload": {
    "id": "f4c47e52-32d1-4d2d-8363-e986338dfd14",
    "model": {
      "id": "f4c47e52-32d1-4d2d-8363-e986338dfd14",
      "url": "/doc/pervye-shagi-PwzVGwvuj6",
      "urlId": "PwzVGwvuj6",
      "title": "🧗‍♂️ Первые шаги",
      "type": "document",
      "properties": null,
      "text": "Некоторые идеи для начала....", // Полный текст документа в формате markdown
      "tasks": { // Данные по чеклистам в документе
        "completed": 3,
        "total": 9
      },
      "createdAt": "2022-07-02T12:22:57.900Z",
      "createdBy": {
        "id": "dba19bd7-a3d5-4ae4-af67-561048029d82",
        "name": "Local Dmitry",
        "avatarUrl": "https://.....",
        "color": "#FF5C80",
        "isAdmin": true,
        "isSuspended": false,
        "isViewer": false,
        "createdAt": "2022-07-02T12:22:57.669Z",
        "updatedAt": "2022-07-18T13:22:40.182Z",
        "lastActiveAt": "2022-07-18T13:22:40.182Z"
      },
      "updatedAt": "2022-07-18T13:24:40.271Z",
      "updatedBy": {
        "id": "dba19bd7-a3d5-4ae4-af67-561048029d82",
        "name": "Local Dmitry",
        "avatarUrl": "https://....",
        "color": "#FF5C80",
        "isAdmin": true,
        "isSuspended": false,
        "isViewer": false,
        "createdAt": "2022-07-02T12:22:57.669Z",
        "updatedAt": "2022-07-18T13:22:40.182Z",
        "lastActiveAt": "2022-07-18T13:22:40.182Z"
      },
      "publishedAt": "2022-07-02T12:22:57.907Z",
      "archivedAt": null,
      "deletedAt": null,
      "teamId": "39c8c10c-875b-4b77-86e9-c38494a67576",
      "template": false,
      "templateId": null,
      "collaboratorIds": [
        "dba19bd7-a3d5-4ae4-af67-561048029d82"
      ],
      "revision": 2,
      "fullWidth": false,
      "collectionId": "681782d7-c561-484a-9289-10ef9181d3cb",
      "parentDocumentId": null,
      "tableOrder": 0
    }
  }
}