API y webhooks

Conecta Ciarem con tus propios sistemas con una API y webhooks

Gestiona contactos y la configuración de tu CRM, lee conversaciones y envía plantillas de WhatsApp desde tu código. Los webhooks le avisan a tu servidor en cuanto cambia un contacto, una conversación o un mensaje, firmados y con reintentos.

Empezar prueba de 14 días gratis
  • Sin tarjeta de crédito. Cancela cuando quieras.

Disponibilidad: El acceso a la API y los webhooks están incluidos en Growth (10 solicitudes por segundo) y Scale (20 por segundo), y abiertos durante la prueba gratis de 14 días (5 por segundo). El plan Solo no los incluye.

Integraciones que no se descuadran

  1. Nuestro CRM y Ciarem se desfasan, y alguien los cuadra en un Excel.

    1. Los contactos se crean, leen, actualizan y eliminan por la API, y los webhooks de contactos traen el contacto completo.

  2. Nuestro sistema sabe cuándo sale un pedido, pero el WhatsApp se envía a mano.

    2. Envía una plantilla aprobada a un destinatario o a cien en una sola llamada, y sigue qué pasó con cada uno.

  3. Consultamos cambios cada pocos minutos y aun así se nos escapan cosas.

    3. Los webhooks envían cada evento a tu servidor en segundos y reintentan los fallos hasta por 3 días.

Una API REST para tu CRM y WhatsApp

Las claves pertenecen a tu organización, no a una persona, así que siguen funcionando cuando alguien del equipo se va. La referencia de cada endpoint se genera desde el contrato en vivo, y los cambios son aditivos y quedan en el changelog.

  • Contactos: crear, leer, actualizar y eliminar
  • CRM: propiedades personalizadas y etapas del embudo
  • Conversaciones: leer el historial de mensajes
  • Plantillas de WhatsApp: crearlas, ver qué necesita un envío y enviarlas
  • Campañas: seguir a cada destinatario, o cancelarlas

Webhooks en el momento en que algo cambia

Dale a Ciarem una URL HTTPS, elige los eventos que te importan o deja activado Enviar todos los eventos, y cada evento llega como un POST en segundos. Los eventos de contactos traen el contacto completo, así que la mayoría de integraciones no necesita volver a consultar.

  • Contactos creados, actualizados, eliminados o fusionados
  • Cambios de etapa del embudo y de propietario
  • Conversaciones creadas, asignadas y cerradas
  • Cada mensaje entrante de un cliente
  • Formularios de WhatsApp enviados, con sus respuestas

Firmados, reintentados y registrados

Cada solicitud lleva un encabezado Ciarem-Signature que verificas con el secreto de firma del endpoint. Una entrega fallida se reintenta con esperas cada vez más largas hasta por 3 días, cada intento queda en el registro de entregas durante 30 días, y puedes reenviar una entrega o enviar un evento de prueba cuando quieras.

Hecha para reintentar sin riesgo

Cada respuesta trae tu límite de solicitudes en los encabezados, para que regules el ritmo sin contar llamadas. Los envíos de plantillas aceptan un Idempotency-Key, así que un reintento después de un timeout nunca envía dos veces, y una llamada de envío cuenta como una solicitud lleve un destinatario o cien.

Cómo empezar

Empieza a construir

  1. 01

    Crea una clave de API

    Un administrador abre Configuración, luego Claves de API. Copia el secreto cuando aparece: Ciarem guarda solo un hash y lo muestra una sola vez.

  2. 02

    Agrega un endpoint de webhook

    En Configuración, luego Webhooks, haz clic en Agregar endpoint, pega tu URL HTTPS, elige los eventos y guarda el secreto de firma.

  3. 03

    Envía un evento de prueba

    Abre el endpoint, elige un evento en Evento de prueba y haz clic en Enviar evento de prueba. Ciarem te muestra qué respondió tu servidor.

Preguntas frecuentes

Growth, con 10 solicitudes por segundo, y Scale, con 20. Está abierta durante la prueba gratis de 14 días con 5 por segundo, para que construyas antes de pagar. Solo no la incluye.

Sí, plantillas de WhatsApp aprobadas, a un destinatario o hasta cien en una sola llamada. Luego puedes seguir qué pasó con cada destinatario.

No. Los webhooks son parte del acceso a la API en Growth, Scale y la prueba, con hasta 10 endpoints por organización.

Cada solicitud va firmada en el encabezado Ciarem-Signature con el secreto de tu endpoint, que empieza por whsec_. Verifícala antes de confiar en el contenido.

Las entregas fallidas se reintentan con esperas crecientes hasta por 3 días, con el mismo id de evento. Un endpoint en el que fallan todas las entregas durante 3 días seguidos se desactiva hasta que lo vuelvas a activar.

En el centro de ayuda de Ciarem, en Referencia de la API. Cada endpoint se genera desde el contrato en vivo, así que lo que lees es lo que la API responde.

Funciones relacionadas

Tu próximo cliente ya te escribió.

Prueba Ciarem gratis durante 14 días y mira cómo responde con tu información antes de que lo vean tus clientes.

Empezar prueba de 14 días gratis
  • Sin tarjeta de crédito. Cancela cuando quieras.