Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / /

Integrações do Atlas criam WEBHOOK

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Crie ou atualize uma integração do webhook para seu projeto.

A chave de API solicitante deve ter a role "Proprietário da organização" ou "Proprietário do projeto" para configurar uma integração do webhook.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.

Sintaxe do comando
atlas integrations create WEBHOOK [options]
Nome
Tipo
Obrigatório
Descrição

-h, --help

false

ajuda para WEBHOOK

-o, --output

string

false

Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.

--projectId

string

false

String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.

--secret

string

true

Segredo que protege seu webhook.

--url

string

true

Endereço web do endpoint para o qual o Atlas envia notificações.

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

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

Voltar

VICTOR_OPS