Transacional — Evento¶
Dispara um evento externo para um ou mais contactos. O evento faz os contactos entrar numa
automação por um nó externalEventEntry, ou liberta os
contactos que esperam num nó externalEvent.
Endpoint¶
| Método | URL |
|---|---|
POST |
/transactional/<transactional>/event/<payload> |
<transactional>é o objeto transacional da automação.<payload>identifica o nó. É a codificação Base64 de{"type":"automation","node":"externalEventEntry","nodeId":<node_id>}, com"node":"externalEvent"para um nóexternalEvent. O editor de automações mostra o URL completo do evento nas definições do nó. Também pode enviarpayloadcomo parâmetro em vez de no caminho.
POST¶
Envie os parâmetros form-encoded ou na query string. Os corpos JSON não são suportados.
| Parâmetro | Tipo | Descrição |
|---|---|---|
email / email[] |
string / array de string | Email(s) do(s) contacto(s), em minúsculas |
telephone / telephone[] |
string / array de string | Telefone(s) do(s) contacto(s), mesmo índice de email[], no mesmo formato da lista de contactos |
É obrigatório pelo menos email ou telephone; caso contrário, o pedido falha com
Missing both telephone and email arguments.
- Os contactos são procurados na lista do objeto transacional por email e telefone, depois por email e depois por telefone.
- Um contacto que não existe é criado. Se a lista usar double opt-in, fica pendente e é enviado
o email de opt-in; caso contrário, fica subscrito, o que também inicia as automações
contactSignupda lista. - Com um nó
externalEventEntry, um contacto que já está na automação recomeça no nó a seguir à entrada. - Nada acontece se a automação estiver desativada. A resposta não indica se os contactos
avançaram: verifique com
GET /transactional/<transactional>/automation/<automation>e nas Estatísticas.
Devolve: success: true. As outras chaves da resposta são internas e podem mudar.
Exemplo: