Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / /

atlas integrations create WEBHOOK

在此页面上

  • 语法
  • 选项
  • 继承选项
  • 输出
  • 举例

为项目创建或更新 Webhook 集成。

请求的 API 密钥必须具有组织所有者或项目所有者角色才能配置 Webhook 集成。

要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas integrations create WEBHOOK [options]
名称
类型
必需
说明
-h,--help
false
WEBHOOK 帮助
-o, --output
字符串
false
输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。
--projectId
字符串
false
标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。
--secret
字符串
true
保护 Webhook 的密钥。
--url
字符串
true
Atlas 向其发送通知的端点网址。
名称
类型
必需
说明
-P, --profile
字符串
false
要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.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

后退

VICTOR_OPS