Налаштувати вебхук команди

Довідник API

Налаштувати вебхук команди

Request

Створює або замінює конфігурацію вебхука команди.

Передумови: callbackUrl має бути HTTPS-URL довжиною від 1 до 1024 символів, з іменем хоста, без даних користувача, без фрагмента та з коректним портом. Усі адреси, у які він розв'язується, повинні маршрутизуватися в інтернеті; діапазони localhost, приватні, link-local, CGNAT, метаданих хмари, зарезервовані протоколом, документаційні та 6to4 відхиляються. Та сама перевірка повторюється в момент відкриття з'єднання під час доставки, тому імʼя, яке згодом розв'яжеться у приватний діапазон, призведе до невдачі цієї доставки, а не до звернення у вашу мережу.
Дія: виконує upsert єдиної конфігурації команди із серверного контексту. teamId ніколи не читається із запиту, тому той, хто викликає, не може налаштувати іншу команду. Ендпоінти Local API та Open API читають і пишуть той самий запис, а відповідь повторює збережене.
Вимкнення: enabled: false зберігає URL і припиняє створення нових подій. Уже поставлені в чергу події скасовуються по одній, якщо на момент їх авторизації конфігурація все ще вимкнена, тому швидке повторне ввімкнення дає їм продовжитися.
Повтор: безпечно. Збереження — це upsert за командою, тому повторення того самого запиту сходиться до того самого стану.
Версія клієнта: потрібен клієнт MoreLogin v2.66.0 або новіший, оскільки локально цей маршрут публікує саме настільний клієнт. Ендпоінт Open API від клієнта не залежить.

Контракт зворотного виклику, назви подій і розклад повторів див. у Webhooks.

Задокументовані бізнес-помилки: 41001. Значення кодів див. у Error Codes. Будь-яка операція може додатково повернути загальні коди.

Bodyapplication/json

callbackUrlstring, <= 1024 charactersrequired

HTTPS-URL, який приймає події. Від 1 до 1024 символів.

enabledbooleanrequired

Чи ввімкнено доставку для команди.

POST

/api/webhook/config

curl -i -X POST \
  http://127.0.0.1:40000/api/webhook/config \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  }'

Responses

Успіх. data — об'єкт із полями callbackUrl та enabled, що повторює збережену конфігурацію.

Headers

any

Bodyapplication/json

codeintegerrequired

Код результату. 0 — успіх; інші коди означають помилку.

msgstring or nullrequired

Повідомлення про помилку

dataobjectrequired

requestIdstringrequired

Ідентифікатор запиту операції

Response

{
  "code": 0,
  "msg": "",
  "data": {
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  },
  "requestId": ""
}