DocsAPI y webhooksWebhooks

Webhooks: eventos y payloads

Los webhooks te avisan cuando pasan cosas en Tickets: MelonHelp hace un POST a tu endpoint con el evento, firmado con tu secreto para que verifiques su origen. Es la base de automatización disponible hoy.

Configurar un webhook

  1. En Tickets, ve a la configuración de Webhooks del workspace.
  2. Registra la URL de tu endpoint (HTTPS).
  3. Guarda el secreto que se genera — lo vas a usar para verificar cada envío.
  4. Genera un evento de prueba (crea un ticket) y confirma que tu endpoint lo recibió.

Forma de los eventos

Cada envío es un POST con JSON: el tipo de evento, el timestamp y el objeto afectado (por ejemplo, el ticket con su estado y prioridad). Diseña tu handler tolerante a campos nuevos — los payloads pueden crecer.

Verificar la firma

Verifica el header de firma contra tu secreto antes de procesar. Rechaza lo que no verifique: cualquiera puede hacer POST a una URL pública; solo MelonHelp puede firmarlo con tu secreto.

Buenas prácticas

  • Responde 2xx rápido y procesa async — los timeouts cuentan como fallo.
  • Maneja reintentos idempotentes: el mismo evento puede llegar más de una vez.
  • Un endpoint por integración, cada uno con su secreto.

Ideas de uso

Avisos a Slack de guardia, sincronizar tu CRM, alimentar tu data warehouse — ver automatizaciones.