Webhook Credentials
La pestaña WEBHOOK CREDENTIALS ( ) muestra las credenciales de autenticación utilizadas por Flexible Actions para enviar peticiones HTTP a endpoints registrados. Estas peticiones son una de las opciones para enviar notificaciones cuando se activa una alerta y se configuran en el paso ACTIONS de creación de una alerta (en Platform Events y Runtime Alerts), dentro de la opción Webhook.
Las credenciales pueden consistir en client ID o client ID + secret. Su configuración también incluye la ubicación donde se viajará la información en la petición (que puede estar en el header o query param).
Lista de credenciales
La pestaña muestra todas las credenciales existentes en Flexible Actions, ordenadas según la fecha de la última modificación:
La tabla de listado muestra el nombre que identifica la credencial, su tipo (si Client ID
o Client ID and Secret
) y la fecha de última modificación en su configuración.
Además, la columna OPTIONS tiene dos iconos de acción:
-
para editar una credencial;
-
para eliminarla.
Puede eliminar una credencial incluso si se está utilizando en la configuración de Webhook de una alerta. En este caso, cuando consulta la pantalla de resumen de la alerta, su webhook se mostrará como de ninguna autenticación («No Auth»).
Creación de credenciales
Para crear una nueva credencial, haga clic en el botón + NEW CREDENTIAL en la esquina superior derecha de la pantalla.
Introduzca un nombre para la credencial y elija su tipo: Client ID
o Client ID and Secret
.
Esto abrirá los otros campos de configuración, que dependen del tipo.
El nombre de la credencial no tiene que ser único, pero si tiene varias credenciales con el mismo nombre, es difícil seleccionar la que desee al configurar un webhook en una alerta. |
Client ID
Si su credencial es del tipo Client ID, rellene:
-
Field Name: nombre del campo que estará en la petición (componiendo el par nombre/valor);
-
Location: ubicación de la información en la petición, que puede ser
Header
oQuery Param
; -
Value: valor del client ID, componiendo el par nombre/valor.
Cuando solo se utiliza el client ID, se muestra sin codificación en la petición.
Tomando el ejemplo de la imagen anterior, donde se registró el client ID para ser incluido en headers, el header contendrá: clientid: link
.
Si se incluyera el mismo ID de cliente como query param, tendríamos una petición POST /?clientid=link
.
Después de guardar la credencial, se puede utilizar para configurar un webhook en Platform Events y Runtime Alerts.
Client ID and Secret
Si su credencial es del tipo Client ID and Secret, rellene:
-
Field Name: nombre del campo que estará en la petición (componiendo el par nombre/valor);
-
Location: ubicación de la información en la petición, que puede ser
Header
oQuery Param
; -
Client ID: valor de ID de cliente, componiendo el par nombre/valor.
-
Secret: valor que se agregará al client ID.
Cuando el client ID se utiliza con secret, el valor incluido en la petición se compone tanto del client ID como del secret, codificados en Base64.
Tomando el ejemplo de la imagen anterior, donde se registró el valor de client ID + secret para ser incluido en headers, el header contendrá: clientid: bGlua2Vwb25h
.
Si se incluyera el mismo client ID como query param, tendríamos una petición POST /?clientid=bGlua2Vwb25h
.
Después de guardar la credencial, se puede utilizar para configurar un webhook en Platform Events y Runtime Alerts.
Edición de credenciales
Para editar una credencial, haga clic en en la columna OPTIONS de la lista de credenciales existentes, lo que dará lugar a una pantalla igual a la de creación de credenciales.
Puede editar cualquier campo de una credencial, excepto el tipo (client ID o Client ID and Secret). En este caso, debe eliminar la credencial y crear una nueva.
Share your suggestions with us!
Click here and then [+ Submit idea]