Atlas integrations create WEBHOOK
プロジェクトの Webhook 統合を作成または更新します。
Webhook 統合を構成するには、リクエスト元の API キーに組織オーナーまたはプロジェクトオーナーのロールが必要です。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
コマンド構文
atlas integrations create WEBHOOK [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | WEBHOOK | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--secret | string | true | Webhook を保護する シークレット 。 |
--url | string | true | Atlas が通知を送信するエンドポイントのウェブアドレス。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Webhook integration configured.
例
# Integrate a webhook with Atlas that uses the secret mySecret for the project with the ID 5e2211c17a3e5a48f5497de3: atlas integrations create WEBHOOK --url http://9b4ac7aa.abc.io/payload --secret mySecret --projectId 5e2211c17a3e5a48f5497de3 --output json