Definição do método de autenticação para webhooks de pré-mensagem e pós-mensagem

Este documento mostra o processo de configuração da autenticação para webhooks de pré-mensagem e webhooks de pós-mensagem em watsonx Assistant. Ele aborda os métodos de autenticação disponíveis e como configurá-los.

Visão geral

Os webhooks permitem que sistemas externos se comuniquem com o site watsonx Assistant. A autenticação garante que somente fontes autorizadas possam acionar webhooks. Esta documentação descreve o processo de configuração e gerenciamento da autenticação de webhooks, que introduz um método atualizado de autenticação de webhooks.

Antes de Iniciar

Antes de configurar a autenticação do webhook:

  • Você deve ter permissões de gravação no ambiente.
  • Você deve ter detalhes de autenticação do servidor de destino, incluindo URLs de solicitação de token (se necessário) e quaisquer segredos, como uma senha ou token.

Procedimento

  1. Vá para Início > Ambientes.

  2. Selecione o ícone de engrenagem Configurações na guia Rascunho > Ambiente de rascunho ou na guia Ao vivo > Ambiente ao vivo.

  3. Selecione entre webhook pré-mensagem ou webhook pós-mensagem, de acordo com o que você deseja definir.

  4. Role para baixo até Configuração de webhook e cole a API URL.

  5. Clique em Edit authentication (Editar autenticação ) para abrir a página Authentication set up (Configuração de autenticação ).

  6. No menu suspenso, escolha uma das seguintes opções:

  7. Clique em Salvar.

Sem autenticação

Esse é a opção padrão.

Autenticação básica

  1. Digite um nome de usuário e uma senha.

Portador auth

  1. Digite o token de portador.

Autenticação de chave de API

  1. Digite o nome da chave da API e a chave da API.

JWT assinado

  1. Digite o segredo.
  2. Clique no ícone Show password (Mostrar senha) para visualizar o segredo.

OAuth 2.0

Se você usar a string Scope, ela deverá ser um conjunto delimitado por espaço de um ou mais escopos de autenticação definidos pelo servidor de destino. Por exemplo, gravação, leitura+gravação, leitura de e-mail e assim por diante.

  1. Em Tipo de concessão, escolha uma das seguintes opções:

  2. Clique em Salvar.

Senha

  1. Digite o nome de usuário de seu webhook.

  2. Digite a senha do seu serviço de webhook.

  3. Insira o ID do cliente para seu serviço de autenticação de webhook.

  4. Digite o segredo do cliente para autenticar seu webhook.

  5. Digite o token URL.

  6. Digite o token Refresh URL.

  7. Opcional: se o seu serviço precisar de uma cadeia de escopo, digite a cadeia de escopo conforme definido pelo servidor de destino.

  8. Em Autenticação de cliente, você deve escolher uma das seguintes opções:

    • Enviar como cabeçalho Basic Auth: As credenciais de autenticação serão enviadas no cabeçalho HTTP.
    • Enviar como corpo: As credenciais de autenticação serão enviadas no corpo da solicitação.

  9. Digite o prefixo do cabeçalho, por exemplo: Bearer.

Credenciais do cliente

  1. Insira o ID do cliente para seu serviço de autenticação de webhook.

  2. Digite o segredo do cliente para autenticar seu webhook.

  3. Digite o token URL.

  4. Digite o token Refresh URL.

  5. Opcional: se o seu serviço precisar de uma cadeia de escopo, digite a cadeia de escopo conforme definido pelo servidor de destino.

  6. Em Autenticação de cliente, você deve escolher uma das seguintes opções:

    • Enviar como cabeçalho Basic Auth: As credenciais de autenticação serão enviadas no cabeçalho HTTP.
    • Enviar como corpo: As credenciais de autenticação serão enviadas no corpo da solicitação.

  7. Digite o prefixo do cabeçalho, por exemplo: Bearer.

Código de autorização

  1. Insira o ID do cliente para seu serviço de autenticação de webhook.

  2. Digite o servidor de autorização URL.

  3. Digite o token URL.

  4. Digite o token Refresh URL.

  5. Opcional: se o seu serviço precisar de uma cadeia de escopo, digite a cadeia de escopo conforme definido pelo servidor de destino.

  6. Em Autenticação de cliente, você deve escolher uma das seguintes opções:

    • Enviar como cabeçalho Basic Auth: As credenciais de autenticação serão enviadas no cabeçalho HTTP.
    • Enviar como corpo: As credenciais de autenticação serão enviadas no corpo da solicitação.

  7. Digite o prefixo do cabeçalho, por exemplo: Bearer.

  8. Opcional: Dependendo do servidor de destino, copie o URL de redirecionamento para o campo "Callback URL " do seu aplicativo OAuth.

  9. Clique em Grant Access (Conceder acesso ).

  10. Conclua as etapas na página apresentada pelo servidor de concessão.

  11. Você é redirecionado de volta ao Assistente e o modal de edição é reaberto.

  12. Digite o segredo do cliente em Client ID agora que o campo está visível.

Customizado

  1. Digite o nome do tipo de concessão personalizada de seu webhook.

  2. Digite o token URL.

  3. Digite o token Refresh URL.

  4. Opcional: se o seu serviço precisar de uma cadeia de escopo, digite a cadeia de escopo conforme definido pelo servidor de destino.

  5. Em Autenticação de cliente, você deve escolher uma das seguintes opções:

    • Enviar como cabeçalho Basic Auth: As credenciais de autenticação serão enviadas no cabeçalho HTTP.
    • Enviar como corpo: As credenciais de autenticação serão enviadas no corpo da solicitação.

  6. Digite o prefixo do cabeçalho, por exemplo: Bearer.

Se você precisar adicionar segredos personalizados ao seu aplicativo, siga estas etapas:

  1. Clique em Add secret +.

  2. Digite o nome do segredo e o valor do segredo.

  3. Opcional: se você quiser adicionar mais nomes e valores secretos, clique em Add secret +.

  4. Clique em Add parameter +.

  5. Digite o nome do parâmetro e o valor do parâmetro.

  6. Opcional: se você quiser adicionar mais nomes e valores de parâmetros, clique em Add parameter +.