Esquema:
- ¿Qué son los webhooks?
- Parámetros de webhooks de Snov.io
- Cómo suscribirse a webhooks a través de la API de Snov.io
- Cómo administrar webhooks a través de la API de Snov.io
Los webhooks son una forma de que las aplicaciones se comuniquen entre sí. En esencia, son notificaciones enviadas de una aplicación a otra cuando sucede un evento predeterminado:
- Una aplicación activa un webhook cuando ocurre un evento elegido
- La otra aplicación recibe información en tiempo real sobre el evento.
Por ejemplo, cuando un destinatario responde a un email de campaña, se envía un webhook al extremo de URL especificado. Luego, el punto final puede tomar medidas en función de la información recibida de un webhook. Esto crea posibilidades para configurar integraciones automatizadas.
Con los webhooks de Snov.io:
- integra tu propia aplicación con Snov.io
- recibir notificaciones de eventos o actividades que sucedieron en su cuenta Snov.io
- enviar datos en tiempo real desde Snov.io a su aplicación
Hay tres webhooks disponibles en Snov.io en este momento (con más por venir en futuras actualizaciones):
Snov.io enviará un webhook cuando se envíe su campaña de goteo de correo electrónico. Puede elegir cuándo recibirlo: solo cuando se envía el primer email a un destinatario o después de cada email enviado.
Snov.io enviará un webhook cuando reciba una respuesta a su campaña de goteo de correo electrónico. Puede elegir cuándo recibirlo: solo después de la primera respuesta de un destinatario o después de cada respuesta.
Snov.io enviará un webhook cuando un destinatario vea el email de su campaña.
La información del webhook incluirá:
- Email del destinatario
- Marca de tiempo de un evento: cuándo ocurrió el evento
- Nombre de la campaña: el nombre de la campaña de goteo donde ocurrió el evento
- Asunto del email: la línea de asunto del email enviado a un destinatario
- Cuerpo del email: el contenido del email enviado a un destinatario
Parámetros de webhook
Los parámetros del webhook incluyen lo siguiente:
- Objeto: el objeto sobre el que se realiza la acción. En otras palabras, este es un componente de Snov.io (email, cliente potencial o trato) que está vinculado a un webhook.
- Acción: la acción realizada sobre el objeto. En pocas palabras, este es el evento que activa un webhook.
- Endpoint: la dirección URL donde se envía el webhook.
A continuación se muestra la lista de objetos y acciones disponibles actualmente:
Objeto | Acción | ¿Cuándo se activa? |
campaña_email | enviado | Cuando se envía cualquier email al destinatario en cualquier campaña |
enviado_primero | Cuando se envía el primer email al destinatario en cualquier campaña | |
abierto | Cuando el destinatario abre un email en cualquiera de las campañas | |
campaña_respuesta | recibido | Cuando el destinatario responde a cualquier email en cualquiera de las campañas |
recibido_primero | Cuando el destinatario responde por primera vez en alguna de las campañas de goteo |
Cómo suscribirse a webhooks a través de la API de Snov.io
Para ver cómo se desarrolla un webhook en tiempo real, usemos Postman y cualquiera de los generadores de puntos finales en línea.
Prepare el entorno de prueba de la API y obtenga un token de acceso a la API
-Regístrese en Postman
-Obtenga un token de acceso a la API
-Prepare una llamada API y autentíquela con un token de acceso
Aquí hay un tutorial detallado sobre la autenticación de su llamada a la API de Snov.io y el uso de Postman para llamadas a la API.
Obtener una dirección URL de punto final
Como ejemplo, usaremos el Beeceptor para generar un punto final gratuito. En su sitio web, escriba cualquier nombre de punto final y haga clic en el botón Crear punto final.
Obtendrá una dirección URL de punto final a la que se enviará un webhook y datos relacionados con un evento en Snov.io. Guarde o copie esta URL para usarla en el siguiente paso.
Suscríbete a un webhook a través de una llamada a la API
Utilice la configuración a continuación para realizar una llamada a la API en Postman o en cualquier otro entorno de prueba de API de su elección:
-Tipo: POST
-URL de solicitud: https://api.snov.io/v2/webhooks
-Parámetros de entrada (consulte también el capítulo de parámetros de Webhook anterior):
event_object | campaña_email | campaña_respondida |
event_action | enviado
enviado_primero abierto |
recibida
recibida_primero |
endpoint_url | https://snovio.free.beeceptor.com |
Después de ingresar todos los parámetros, haga clic en el botón Enviar. Verá la siguiente respuesta:
Estado: activo significa que se ha suscrito con éxito a un webhook.
Compruebe la notificación de webhook en la URL del punto final
Consideramos que el extremo recibió correctamente un webhook si devuelve un código de respuesta de estado correcto 200 OK en 3 segundos.
Si no es así, hacemos varios intentos para volver a enviar un webhook:
1º: inmediatamente después del evento
2º: 20 minutos después del último intento (20 minutos después del evento)
3º: 40 minutos después del último intento (1 hora después del evento)
4º: 60 minutos después del último intento (2 horas después del evento)
5º: 4 horas después del último intento (6 horas después del evento)
6º: 8 horas después del último intento (14 horas después del evento)
7º: 24 horas después del último intento (38 horas después del evento)
Si los siete intentos no tienen éxito, el webhook se desactiva.
Vuelva a Beeceptor y busque un registro POST con datos de webhook de Snov.io. Aquí hay un ejemplo de cómo se ve:
Después de suscribirse a un webhook, cada vez que ocurra un evento elegido en su cuenta de Snov.io, los datos relacionados con un evento se transmitirán instantáneamente al punto final de la URL.
Cómo administrar webhooks a través de la API de Snov.io
Ver una lista de sus webhooks
-Tipo: OBTENER
-Solicitud de URL: https://api.snov.io/v2/webhooks
-Parámetros de entrada: vacío
Eliminar una suscripción de webhook
Elimina un webhook elegido.
Incluya el valor de «id» único del webhook elegido al final de la dirección URL de la solicitud.
Utilice el método «Lista de todos los webhooks» para obtener los valores de ID de sus webhooks.
- Tipo: ELIMINAR
- Solicitud de URL: https://api.snov.io/v2/webhooks/webhook_id
- Parametros de entrada : This method has no input parameters.
- Ejemplo de solicitud de URL: https://api.snov.io/v2/webhooks/8
Cambiar el estado del webhook
Cambia el estado de una suscripción de webhook elegida.
Incluya el valor de «id» único del webhook elegido al final de la dirección URL de la solicitud.
Utilice el método «Lista de todos los webhooks» para obtener los valores de ID de sus webhooks.
- Tipo: OBTENER
- Solicitud de URL: https://api.snov.io/v2/webhooks/webhook_id
- Parametros de entrada:
estado | Activo o desactivado |
- Ejemplo de solicitud de URL: https://api.snov.io/v2/webhooks/14
Nota: Puede crear hasta 50 webhooks. Están disponibles solo para cuentas premium.
¡Actualice su plan ahora, amplíe la funcionalidad de su cuenta Snov.io y suscríbase a los webhooks!