Webhooks
Los webhooks son una forma habitual de comunicación entre aplicaciones para compartir datos en tiempo real. Hoy en día, rara vez tenemos una aplicación independiente que pueda hacerlo todo. La mayoría de las veces, trabajas con muchas aplicaciones o sistemas diferentes que están especializados en realizar determinadas tareas, y todas estas aplicaciones tienen que poder comunicarse entre sí. Ahí es donde entran en juego los webhooks.
Un webhook es un mensaje automatizado de un sistema a otro cuando se cumplen determinados criterios. En Braze, este criterio suele ser la activación de un evento personalizado.
En esencia, un webhook es un método basado en eventos para que dos sistemas distintos tomen medidas eficaces basadas en datos transmitidos en tiempo real. Ese mensaje contiene instrucciones que indican al sistema receptor cuándo y cómo realizar una tarea específica. Por este motivo, los webhooks pueden proporcionarte un acceso más dinámico y flexible a los datos y a la funcionalidad programática, y permitirte configurar recorridos del cliente que agilicen los procesos.
La disponibilidad de los webhooks depende de tu paquete de Braze. Ponte en contacto con tu director de cuentas o administrador del éxito del cliente para empezar.
Artículos de sección
Casos de uso
Los webhooks son una forma excelente de conectar tus sistemas entre sí; al fin y al cabo, los webhooks son la forma en que se comunican las aplicaciones. Estos son algunos escenarios generales en los que los webhooks pueden resultar especialmente útiles:
- Envío de datos a y desde Braze
- Envío de mensajes a tus clientes a través de canales no compatibles directamente con Braze
- Publicar en las API de Braze
Algunos casos de uso más específicos son los siguientes:
- Si un usuario cancela su suscripción al correo electrónico, puedes hacer que un webhook actualice tu base de datos de análisis o CRM con esa misma información, garantizando una visión holística del comportamiento de ese usuario.
- Envía mensajes transaccionales a los usuarios dentro de Facebook Messenger o Line.
- Envía correo directo a los clientes en respuesta a su actividad dentro de la aplicación y en la web utilizando webhooks para comunicarse con servicios de terceros como Lob.com.
- Si un jugador alcanza un determinado nivel o acumula un cierto número de puntos, utiliza webhooks y tu configuración de API existente para enviar una mejora de personaje o monedas directamente a su cuenta. Si envías el webhook como parte de una campaña de mensajería multicanal, puedes enviar un mensaje push o de otro tipo para informar al jugador de la recompensa al mismo tiempo.
- Si eres una aerolínea, puedes utilizar webhooks y tu configuración de API existente para acreditar un descuento en la cuenta de un cliente después de que haya reservado un determinado número de vuelos.
- Un sinfín de recetas “If This Then That” (IFTTT): por ejemplo, si un cliente inicia sesión en la aplicación a través del correo electrónico, esa dirección puede configurarse automáticamente en Salesforce.
Anatomía de un webhook
Un webhook consta de las siguientes partes.
| Parte del webhook | Descripción |
|---|---|
| Método HTTP | Al igual que las API, los webhooks necesitan métodos de solicitud. Se proporcionan a la URL a la que accede el webhook e indican al punto de conexión qué hacer con la información facilitada. Hay cuatro métodos HTTP que puedes especificar: POST, GET, PUT y DELETE. |
| HTTP URL | La dirección URL del punto de conexión de tu webhook. El punto de conexión es el lugar donde enviarás la información que estás capturando en el webhook. |
| Cuerpo de la solicitud | Esta parte del webhook contiene la información que estás comunicando al punto de conexión. El cuerpo de la solicitud puede ser pares clave-valor JSON o texto sin formato. |
Métodos HTTP
La siguiente tabla describe los cuatro métodos HTTP diferentes que puedes especificar en tu webhook.
| Método HTTP | Descripción |
|---|---|
| POST | Este método escribe nueva información en el servidor receptor. Un ejemplo común del método POST en una aplicación del mundo real es un formulario de contacto en un sitio web. Cualquier información que introduzcas en el formulario pasa a formar parte de un cuerpo de solicitud y se envía a un receptor. Es el método más utilizado para enviar datos. |
| GET | Este método recupera información existente, en lugar de escribir información nueva. Por definición, una solicitud GET no admite un cuerpo de solicitud. Es el método más utilizado para pedir datos a un servidor. Por ejemplo, considera el punto de conexión /segments/list. Si hicieras una solicitud GET, te devolvería una lista de tus segmentos. |
| PUT | Este método actualiza la información en el punto de conexión, reemplazando cualquier información existente con lo que hay en el cuerpo de la solicitud. |
| DELETE | Este método elimina el recurso de la URL HTTP. |
Webhooks en Braze
En Braze, puedes crear un webhook como campaña de webhook, campaña de API o componente de Canvas.
- En el dashboard de Braze, ve a Campañas.
- Haz clic en Crear campaña y selecciona Webhook.
Consulta Crear un webhook para más información.
- En el dashboard de Braze, ve a Campañas.
- Haz clic en Crear campaña y selecciona Campaña de API.
- Haz clic en Añadir mensajes y selecciona Webhook.
- Formatea tu llamada a la API para incluir un objeto webhook.
Consulta Crear un webhook para más información.
- En tu Canvas, crea un nuevo componente.
- En la sección Mensaje de tu componente, selecciona Webhook.
Consulta Crear un webhook para más información.
Gestión de errores de webhook y límite de velocidad
Cuando Braze recibe una respuesta de error de una llamada de webhook, ajustamos automáticamente el comportamiento de envío de ese webhook basándonos en estas cabeceras de respuesta:
Retry-AfterX-Rate-Limit-LimitX-Rate-Limit-RemainingX-Rate-Limit-Reset
Estas cabeceras nos ayudan a interpretar los límites de velocidad y a ajustar la velocidad de envío en consecuencia para evitar más errores. También aplicamos una estrategia de retirada exponencial para los reintentos, que ayuda a reducir el riesgo de saturar tus servidores espaciando los intentos de reintento en el tiempo.
Si detectamos que la mayoría de las solicitudes de webhook a un host específico están fallando, aplazaremos temporalmente todos los intentos de envío a ese host. Después, reanudaremos el envío tras un periodo de enfriamiento definido, permitiendo que tu sistema se recupere.