EasyUC
4.8.7

Administración

Webhooks y registro de entregas

Notifique a un sistema de terceros, como HTTP POST, los cambios en usuarios, teléfonos y buzones de voz.

EasyUC · Versión 4.8.7

En EasyUC: EasyUC Cisco → Administration → Integrations & Communication → Webhooks

Para qué sirve

Un webhook notifica eventos de EasyUC a otro sistema. En cuanto se crea, modifica o elimina un usuario final, un teléfono, un device profile, un buzón de voz o una tarea de Enduser, EasyUC envía una solicitud POST con los detalles a la dirección almacenada.

Los destinatarios típicos son sistemas de tickets y sistemas de inventario o de facturación. EasyUC registra cada entrega con la solicitud, la respuesta y el código de respuesta. Si una entrega falla, EasyUC lo intenta de nuevo, hasta ocho veces en total.

Requisitos previos

  • Una cuenta con el tipo de acceso Administrator (full access) (ROLE_APP_ADMIN) o la cuenta de propietario (ROLE_OWNER). Solo estas cuentas ven el menú Administration.
  • Una dirección del destinatario que acepte solicitudes POST y sea accesible desde el servidor EasyUC.
  • Para HTTPS, un certificado del destinatario en el que confíe el servidor EasyUC.
  • Si el destinatario exige autenticación: nombre de usuario y contraseña para Basic Auth.
  • Para los correos de error: un envío de correo electrónico configurado.

Paso a paso: crear un webhook

  1. Abra el espacio de trabajo EasyUC Cisco.
  2. Seleccione Administration → Integrations & Communication → Webhooks.
  3. Haga clic en Add Webhook, arriba a la derecha.
  4. En Payload URL, introduzca la dirección del destinatario, por ejemplo https://tickets.intern/hooks/easyuc.
  5. En SSL verification, deje la selección Enable SSL verification tal como está.
  6. Si el destinatario exige autenticación, active Credentials (Basic Auth) y rellene Username, Password y Retype Password.
  7. En Add email addresses (type an e-mail address and press enter), introduzca las direcciones que deben recibir un correo en caso de error de entrega.
  8. En Which events (actions) would you like to trigger this webhook?, seleccione Send me everything o Let me select individual actions y marque después Create, Update y Delete para cada objeto.
  9. En To which CUCM connections would you like to apply this webhook?, seleccione All o Select connections y después los clústeres en Connections.
  10. Haga clic en Create. El webhook aparece en la lista con la insignia enabled y la indicación This hook has never been triggered.

Paso a paso: comprobar la entrega

  1. Desencadene un evento correspondiente, por ejemplo modificando un usuario de prueba.
  2. En la fila del webhook, haga clic en Actions → Audit Logs.
  3. Lea la columna Event Status: pending, processing, success o error, junto con el response code del destinatario.
  4. En la fila, haga clic en View → Request sent para ver los datos transferidos.
  5. Haga clic en View → Response received para ver la respuesta del destinatario.

Paso a paso: modificar, desactivar o eliminar un webhook

  1. En la fila, haga clic en Actions → Update. Se abre la ventana Update Webhook.
  2. Para desactivarlo temporalmente, desactive Enable. Los demás campos desaparecen y la configuración permanece almacenada.
  3. Si es necesario, modifique la dirección, los eventos o las conexiones y haga clic en Update.
  4. Para eliminarlo, seleccione Actions → Delete y confirme la consulta Are you sure?.

Campos y opciones

Campos y opciones
Campo / acciónSignificado y uso
EnableSolo al editar. Desactivado: el webhook no envía nada. Los webhooks nuevos están activados.
Payload URLDirección a la que EasyUC envía la solicitud POST.
SSL verificationEnable SSL verification (predeterminado) verifica el certificado del destinatario. Disable (not recommended) desactiva la verificación.
Credentials (Basic Auth)Interruptor Enabled o Disabled. Activado: EasyUC se autentica ante el destinatario con Username y Password. Valor predeterminado: desactivado.
Add email addressesDestinatarios de un correo en caso de errores de entrega. Son posibles varias direcciones; complete cada una con Intro.
Send me everything / Let me select individual actionsValor predeterminado: Send me everything. Con la selección individual aparecen los grupos de objetos.
EnduserCreate, Update, Delete y Auto Delete (compact info) para los usuarios eliminados por la limpieza automática.
VoicemailsCreate, Update, Delete para los buzones de voz.
PhonesCreate, Update, Delete para los dispositivos.
Device ProfilesCreate, Update, Delete para los device profiles.
Enduser TasksCreate y Delete. Además, la opción Send full task info (predeterminada) o Send compact task info.
All / Select connectionsValor predeterminado: All los clústeres. Con una selección, solo los eventos de las conexiones seleccionadas.
Redelivery (registro de entregas)Muestra true si la entrada es un nuevo intento de entrega; en caso contrario, false.
Created At / Delivered AtHora del evento y de la entrega correcta. Debajo, cuando corresponda, sent after <number> attempts o not delivered after 8 attempts.

Comprobar el resultado y acotar errores

  • Éxito: el registro de entregas muestra success con el código de respuesta del destinatario y una hora en Delivered At.
  • Estado error con un código de respuesta de 400 o superior: el destinatario rechazó la solicitud. Revise la dirección, las credenciales y la respuesta en Response received.
  • Estado error sin un código de respuesta utilizable: EasyUC no puede alcanzar al destinatario o no confía en el certificado. Revise la resolución de nombres, el firewall y la cadena de certificados. No desactive la verificación SSL de forma permanente.
  • Estado pending (after <number> attempts): EasyUC está intentando de nuevo la entrega. Tras ocho intentos se muestra not delivered after 8 attempts.
  • El destinatario debe poder gestionar que el mismo evento llegue varias veces.
  • No se crea ninguna entrada: el evento no coincide con la selección de acciones o conexiones, o el webhook está desactivado.

Capítulos relacionados