Avisos instantáneos sobre las automatizaciones
POST
https://app.sendapp.ai/api/automations/hooks
Suscribe una de tus direcciones a las ejecuciones de una automatización, de cualquier tipo: en cuanto empieza, termina o falla, SendApp envía un POST con la automatización, la ejecución, el contacto y los datos del evento. Es lo que usa el trigger instantáneo de Zapier. La lista de todas las automatizaciones se lee con
GET /api/automations?all=1; GET /api/automations/hooks muestra las suscripciones, GET /api/automations/hooks/sample un ejemplo, DELETE /api/automations/hooks/{id} elimina una. Cada envío lleva la cabecera
X-SendApp-Signature: t=<unix>,v1=<hmac>: HMAC-SHA256 de t.cuerpo con el secret, que recibes una sola vez al crear la suscripción.Si tu dirección responde 410, la suscripción se elimina. Con 429, 5xx o sin respuesta, el envío se reintenta hasta 4 veces.
Si tu dirección falla continuamente (20 envíos seguidos), la suscripción se pone en pausa: durante ese tiempo los eventos no se envían ni se recuperan después. SendApp vuelve a intentarlo aproximadamente una vez por hora con el evento de ese momento, y la primera respuesta correcta reactiva la suscripción. También se reactiva si la creas de nuevo. Si sigue fallando durante aproximadamente una semana de intentos, se elimina. Con más de 500 envíos en espera por suscripción, o 1000 por cuenta, los nuevos se omiten. Tu dirección debe responder en 4 segundos; si no, el envío cuenta como fallido. El campo
paused de la suscripción indica si está en pausa, y te avisamos por email una vez por cada pausa.run.reason es un código fijo, nunca un texto: opted_out, app_off, timeout, step_failed, skipped o vacío.Los enlaces
order_status_url y tracking_url pueden abrir datos del destinatario sin iniciar sesión: trátalos como confidenciales.Si la conexión con la que creaste la suscripción caduca, los envíos se ponen en pausa y los eventos de ese periodo no se recuperan: te avisamos una sola vez, en el panel y por email. Vuelve a conectarla para reanudarlos.
Las pruebas de la automatización y las ejecuciones omitidas por sus controles (antirrepetición, horarios de envío) no envían nada.
Recibes datos personales del contacto en tu herramienta: sigues siendo responsable de ellos y debes respetar el estado
opted_out. Un contacto excluido no bloquea el envío: contact.id es la clave para encontrar el contacto mediante las API. El cuerpo siempre incluye contact.opted_out y contact.marketing_consent, y run.skipped_for_opt_out es verdadero si un paso o la ejecución se omitieron por exclusión. No contiene textos de las conversaciones.Un email fallido puede enviar tanto
run_completed como run_failed para la misma ejecución: el paso que pone el email en cola cierra la ejecución y, si después el email falla, la ejecución pasa a fallida.La suscripción se interrumpe si revocas la conexión o la clave API con la que se creó. Los envíos también se detienen con la cuenta suspendida, el plan caducado o sin acceso a la API.
Parámetros
5 · 1 obligatorios
url
obligatorio
Dirección https pública.
events
opcional
Uno o varios de
run_started, run_completed, run_failed. Predeterminado: run_started.
automation_id
opcional
Vacío = todas las automatizaciones de la cuenta.
label
opcional
Un nombre para reconocerla.
include_event_data
opcional
Incluye los datos del evento que inició la regla, en
data.hook_data, además de data.payment_link y data.deal_name. Desactivado de forma predeterminada: si está desactivado, estos campos no aparecen. Si está activado, se eliminan las credenciales y los campos de texto libre conocidos (body, message, comment, note, description, ticket, assignee, reason), también los anidados. Puede contener datos personales y otros datos de los sistemas conectados, bajo tu responsabilidad. Con el mismo parámetro, GET /api/automations/hooks/sample muestra un ejemplo que incluye estos campos.
¿Necesitas ayuda con la integración? info@sendapp.live