Suscribirse a un evento
target_url debe ser HTTPS público. Se rechazan localhost, IPs privadas y hostnames que resuelven a ellas. La URL se vuelve a comprobar antes de cada entrega. Basta uno de los alcances listados.
Alcance requerido: cualquiera de leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
Suscribirse a un evento › Request Body
target_urlURL HTTPS pública que recibe el evento.
event_typeEvento al que suscribirse.
Objeto de filtro opcional guardado con la suscripción.
Suscribirse a un evento › Responses
La suscripción. La URL de destino no se devuelve.
idId de la suscripción. Envíalo a DELETE /hooks/{subscriptionId}.
event_typeEvento suscrito.
activetrue hasta que se desactiva.
created_atMarca de tiempo ISO-8601.
Desactivar una suscripción
Marca la suscripción como inactiva. Las entregas se detienen. La respuesta es { success: true }.
Alcance requerido: cualquiera de leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
path Parameters
subscriptionIdId devuelto por POST /hooks.
Desactivar una suscripción › Responses
La suscripción fue desactivada.
successObtener un payload de ejemplo
Devuelve un arreglo con un objeto de ejemplo. eventType es form_lead.created, quiz_lead.created, page.published, page.created, product.created, funnel.created, site.created o project.created. Un tipo desconocido devuelve el ejemplo de lead de formulario.
Alcance requerido: cualquiera de leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
path Parameters
eventTypeNombre del evento, por ejemplo form_lead.created.
Obtener un payload de ejemplo › Responses
Un evento de ejemplo en un arreglo.