Business OS · Documentação

#Eventos reservados e o que fica de fora

#Eventos reservados

Cinco nomes existem no contrato, mas nenhuma plataforma os gera hoje. Eles estão reservados para o futuro. Não programe nada em cima deles e não espere recebê-los.

EventoObservação
order.createdReservado.
chargeback.wonReservado. Hoje não sabemos quando um chargeback foi ganho.
chargeback.lostReservado.
payment.linkedReservado. (O fluxo de acesso tem access.payment_linked, que é outro.)
payment.unlinkedReservado. (O fluxo de acesso tem access.payment_unlinked, que é outro.)

Se um dia algum virar real, será um campo novo compatível, anunciado no changelog.

#O que fica fora desta documentação

O fluxo page_events (eventos de página, como visualização) vai somente para a Meta (Conversions API). Não é entregue como webhook a integradores e por isso não tem página aqui.

Também não documentamos rotas internas de operação nem as rotas de concessão de tempo (/v1/access/*).

#Os cinco fluxos que documentamos

Fluxo (stream)O que contém
paymentsO dinheiro: pendente, aprovado, recusado, vencido, reembolso, chargeback.
platform_subscriptionsA assinatura na plataforma de vendas (criada, renovada, em atraso, cancelada).
kb_accessO direito de acesso calculado pelo Business OS. É o recomendado para decidir acesso.
leadsCadastro de interessados.
groupsEntrada, saída e mudanças em grupos.

← Teste ao vivo (em breve)