Настроить вебхук команды

Справочник 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": ""
}