Assinar um evento
target_url precisa ser HTTPS público. Localhost, IPs privados e hostnames que resolvem para eles são recusados. A URL é verificada de novo antes de cada entrega. Basta um dos escopos listados.
Escopo exigido: qualquer um de leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
Assinar um evento › Request Body
target_urlURL HTTPS pública que recebe o evento.
event_typeEvento a assinar.
Objeto de filtro opcional salvo com a assinatura.
Assinar um evento › Responses
A assinatura. A URL de destino não é devolvida.
idId da assinatura. Envie para DELETE /hooks/{subscriptionId}.
event_typeEvento assinado.
activetrue até a assinatura ser desativada.
created_atTimestamp ISO-8601.
Desativar uma assinatura
Marca a assinatura como inativa. As entregas param. A resposta é { success: true }.
Escopo exigido: qualquer um de leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
path Parameters
subscriptionIdId devolvido por POST /hooks.
Desativar uma assinatura › Responses
A assinatura foi desativada.
successObter um payload de exemplo
Devolve um array com um objeto de exemplo. eventType é form_lead.created, quiz_lead.created, page.published, page.created, product.created, funnel.created, site.created ou project.created. Um tipo desconhecido devolve o exemplo de lead de formulário.
Escopo exigido: qualquer um de leads:read, pages:read, products:read, funnels:read, sites:read, projects:read.
path Parameters
eventTypeNome do evento, por exemplo form_lead.created.
Obter um payload de exemplo › Responses
Um evento de exemplo em um array.