Introduccion

Webhook

Para poder recibir actualizaciones sobre cambios en tus reclamos o denuncias, Piramid usa webhooks para enviar notificaciones en tiempo real a tu sistema. Este metodo permite a tu sistema recibir eventos en formato JSON a traves del protocolo HTTP

Puedes usar un webhook para realizar acciones como:

• Sincronizar cambios del reclamo o denuncia dentro de tu sistema
• Disparar acciones en paralelo con proveedores externos
• Agregar alertas basadas en tipos de eventos

Pasos para recibir eventos

Para empezar a recibir eventos en tiempo real, necesitas seguir los siguientes pasos:

1. Crear endpoint local
2. Registar webhook endpoint
3. Verificar conexión
4. Desplegar a producción
5. Registrar webhook en piramid

Crear endpoint local

Para probar tus webhooks, necesitas crear un endpoint local en tu sistema. Puedes hacerlo utilizando cualquier lenguaje de programación que te permita registra un api rest endpoint.

Por ejemplo, puedes registrar un endpoint en Node.js utilizando la librería express:

import express from 'express'
 
const app = express()
 
app.post('/endpoint', (req, res) => {
  res.status(200).json({ message: 'Hi piramid!' })
})
 
app.listen(3000, () => {
  console.log('Example app listening on port 3000!')
})

Registar webhook endpoint

Una vez que ya tienes el endpoint en local, debes registrar un webhook dentro del dashboard de piramid

Selecciona los tipos de eventos que te interesan escuchar

Verificar conexión

Realiza alguna interaccion dentro de la plataforma que dispare uno de los eventos que te hayas seleccionado

Por ejemplo: si seleccionaste el evento claim_status_updated, puedes cambiar el estado de un reclamo y verificar que estes recibiendo la actualizacion en tu endpoint registrado