Skip to main content
Se dispara cada vez que cambia el status de una Campaña. El payload incluye tanto el estado anterior como el nuevo, para que los consumidores puedan reaccionar a transiciones específicas (ej., notificar al llegar a finished, archivar en inactive). Cuando new_status es finished, el payload también incluye el snapshot de analíticas de la campaña, evitando una llamada adicional a la API.
  • Trigger: Cualquier transición de estado (pending a ready, active a inactive, active a cooldown, cooldown a finished, etc.).
  • Filtrado: Al configurar el webhook, puedes restringir entregas a una lista de estados destino vía el arreglo filters.status.

Solicitud

  • Método: POST
  • Content-Type: application/json
  • Endpoint: La URL que configuras en tu integración de webhook.
  • Autenticación: Header X-Altur-Signature para verificación HMAC. Ver Descripción general de Webhooks.

Ejemplo de Payload

Campos del envelope

Objeto data.campaign

Objeto data.analytics (solo cuando status = finished)

Para campañas de llamada el snapshot contiene conteos y tasas de llamadas y contactos. Para WhatsApp contiene conteos y tasas del ciclo de vida del mensaje. Ver la referencia de Detalle de Campaña para la forma completa. El bloque coincide con el campo analytics de la respuesta de detalle.

Respuesta

Devuelve 200 OK para confirmar la recepción. Los fallos se reintentan según la política de reintentos.

Filtrado por Estado

Al configurar la integración de webhook, pasa filters.status como un arreglo de estados objetivo (ej., ["finished"]). Solo las transiciones cuyo new_status esté en esa lista se entregarán. Omitir el filtro entrega todas las transiciones.

Ejemplos de Receptor

Para verificación de firma, ver is_valid_signature en el Descripción general de Webhooks.