Definición del método de autenticación para los webhooks pre-mensaje y post-mensaje

Este documento muestra el proceso para configurar la autenticación para webhooks pre-mensaje y webhooks post-mensaje en watsonx Assistant. Cubre los métodos de autenticación disponibles y cómo configurarlos.

Visión general

Los webhooks permiten a los sistemas externos comunicarse con watsonx Assistant. La autenticación garantiza que sólo las fuentes autorizadas puedan activar los webhooks. Esta documentación describe el proceso para configurar y gestionar la autenticación de webhooks, que introduce un método actualizado para autenticar webhooks.

Antes de empezar

Antes de configurar la autenticación webhook:

  • Debe tener permisos de escritura en el entorno.
  • Debe disponer de los detalles de autenticación del servidor de destino, incluidas las URL de solicitud de token (si es necesario) y cualquier secreto, como una contraseña o un token.

Procedimiento

  1. Vaya a Inicio > Entornos.

  2. Seleccione el icono de engranaje de configuración en la pestaña Borrador > Entorno de borrador o en la pestaña En vivo > Entorno en vivo.

  3. Seleccione entre Pre-message webhook o Post-message webhook, según lo que desee definir.

  4. Desplácese hasta Webhook setup, y pegue la API URL.

  5. Haga clic en Editar autenticación para abrir la página de configuración de autenticación.

  6. En el menú desplegable, elija una de las siguientes opciones:

  7. Pulse Guardar.

Sin autenticación

Esta opción es la predeterminada.

Autenticación básica

  1. Introduzca un nombre de usuario y una contraseña.

Autentificación del portador

  1. Introduzca el token de portador.

Autenticación de la clave API

  1. Introduzca el nombre de la clave API y la clave API.

JWT firmado

  1. Entra en el secreto.
  2. Haz clic en el icono Mostrar contraseña para ver el secreto.

OAuth 2.0

Si utiliza la cadena Scope, debe ser un conjunto delimitado por espacios de uno o más ámbitos de autenticación definidos por el servidor de destino. Por ejemplo, escritura, lectura+escritura, correo electrónico-lectura, etc.

  1. En Tipo de subvención, elija una de las siguientes opciones:

  2. Pulse Guardar.

Contraseña

  1. Introduzca el nombre de usuario de su webhook.

  2. Introduzca la contraseña de su servicio webhook.

  3. Introduzca el ID de cliente para su servicio de autenticación webhook.

  4. Introduzca el secreto del cliente para autenticar su webhook.

  5. Introduzca la ficha URL.

  6. Introduzca el código de actualización URL.

  7. Opcional: si su servicio necesita una cadena de alcance, ingrese la cadena de alcance tal como la define el servidor de destino.

  8. En Autenticación de cliente, debe elegir una de las siguientes opciones:

    • Enviar como cabecera Basic Auth: Las credenciales de autenticación se enviarán en el encabezado HTTP.
    • Enviar como cuerpo: Las credenciales de autenticación se enviarán en el cuerpo de la solicitud.

  9. Introduzca el prefijo de la cabecera, por ejemplo: Portador.

Credenciales del cliente

  1. Introduzca el ID de cliente para su servicio de autenticación webhook.

  2. Introduzca el secreto del cliente para autenticar su webhook.

  3. Introduzca la ficha URL.

  4. Introduzca el código de actualización URL.

  5. Opcional: si su servicio necesita una cadena de alcance, ingrese la cadena de alcance tal como la define el servidor de destino.

  6. En Autenticación de cliente, debe elegir una de las siguientes opciones:

    • Enviar como cabecera Basic Auth: Las credenciales de autenticación se enviarán en el encabezado HTTP.
    • Enviar como cuerpo: Las credenciales de autenticación se enviarán en el cuerpo de la solicitud.

  7. Introduzca el prefijo de la cabecera, por ejemplo: Portador.

Código de autorización

  1. Introduzca el ID de cliente para su servicio de autenticación webhook.

  2. Introduzca el servidor de autorización URL.

  3. Introduzca la ficha URL.

  4. Introduzca el código de actualización URL.

  5. Opcional: si su servicio necesita una cadena de alcance, ingrese la cadena de alcance tal como la define el servidor de destino.

  6. En Autenticación de cliente, debe elegir una de las siguientes opciones:

    • Enviar como cabecera Basic Auth: Las credenciales de autenticación se enviarán en el encabezado HTTP.
    • Enviar como cuerpo: Las credenciales de autenticación se enviarán en el cuerpo de la solicitud.

  7. Introduzca el prefijo de la cabecera, por ejemplo: Portador.

  8. Opcional: Dependiendo del servidor de destino, copie la url de redirección en el campo 'Callback URL ' de su aplicación OAuth.

  9. Haga clic en Conceder acceso.

  10. Complete los pasos de la página que presenta el servidor de concesión.

  11. Se le redirige de nuevo al Asistente y se vuelve a abrir el modal de edición.

  12. Introduzca el secreto del cliente en ID de cliente ahora que el campo está visible.

Personalizado

  1. Introduzca el nombre del tipo de subvención personalizada de su webhook.

  2. Introduzca la ficha URL.

  3. Introduzca el código de actualización URL.

  4. Opcional: si su servicio necesita una cadena de alcance, ingrese la cadena de alcance tal como la define el servidor de destino.

  5. En Autenticación de cliente, debe elegir una de las siguientes opciones:

    • Enviar como cabecera Basic Auth: Las credenciales de autenticación se enviarán en el encabezado HTTP.
    • Enviar como cuerpo: Las credenciales de autenticación se enviarán en el cuerpo de la solicitud.

  6. Introduzca el prefijo de la cabecera, por ejemplo: Portador.

Si necesitas añadir secretos personalizados a tu aplicación, sigue estos pasos:

  1. Haz clic en Añadir secreto +.

  2. Escriba el Nombre secreto y el Valor secreto.

  3. Opcional: Si desea añadir más nombres y valores secretos, haga clic en Añadir secreto +.

  4. Haz clic en Añadir parámetro +.

  5. Escriba el Nombre del parámetro y el Valor del parámetro.

  6. Opcional: Si desea añadir más nombres de parámetros y valores de parámetros, haga clic en Añadir parámetro +.