コンテンツへスキップ

Webhooks

チームの Webhook 設定に関する API。

チームの Webhook を設定

Request

チームの Webhook 設定を作成または置き換えます。

  • 前提条件callbackUrl は 1〜1024 文字の HTTPS URL で、ホスト名を持ち、ユーザー情報とフラグメントを含まず、ポートが正しい必要があります。解決先のすべてのアドレスが公開経路である必要があり、localhost、プライベート、リンクローカル、CGNAT、クラウドメタデータ、プロトコル予約、ドキュメント用、6to4 などの範囲は拒否されます。実際に接続する時点でも同じ検査を行うため、後からプライベート範囲に解決される名前は、その配信が失敗するだけで、あなたのネットワークには到達しません。
  • 副作用:サーバー側コンテキストのチームが持つ唯一の設定を upsert します。teamId はリクエストから読み取らないため、他チームの設定はできません。Local API と Open API は同じレコードを読み書きし、レスポンスは保存内容をそのまま返します。
  • 停止enabled: false は URL を保持したまま、新しいイベントの作成を止めます。すでにキューにあるイベントは、次に承認される時点で設定がまだ停止中であれば 1 件ずつキャンセルされます。すぐに再有効化すれば、そのまま配信が続きます。
  • リトライ:安全です。保存はチーム単位の 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

成功。datacallbackUrlenabled を持つオブジェクトで、保存された設定をそのまま返します。

Headers
any
Bodyapplication/json
codeintegerrequired

戻り結果コード。0 は正常、それ以外は例外を示します。

msgstring or nullrequired

エラーメッセージ

dataobjectrequired
requestIdstringrequired

操作リクエスト ID

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