Avisos instantâneos sobre as automações
POST
https://app.sendapp.ai/api/automations/hooks
Inscreve um dos seus endereços nas execuções de uma automação, de qualquer tipo: assim que começa, termina ou falha, o SendApp envia um POST com a automação, a execução, o contacto e os dados do evento. É o que usa o trigger instantâneo do Zapier. A lista de todas as automações lê-se com
GET /api/automations?all=1; GET /api/automations/hooks mostra as inscrições, GET /api/automations/hooks/sample um exemplo, DELETE /api/automations/hooks/{id} remove uma. Cada envio tem o cabeçalho
X-SendApp-Signature: t=<unix>,v1=<hmac>: HMAC-SHA256 de t.corpo com o secret, que recebe uma só vez ao criar a inscrição.Se o seu endereço responder 410, a inscrição é removida. Com 429, 5xx ou sem resposta, o envio é repetido até 4 vezes.
Se o seu endereço falhar continuamente (20 envios seguidos), a inscrição fica em pausa: nesse período os eventos não são enviados nem recuperados depois. O SendApp tenta de novo cerca de uma vez por hora com o evento desse momento, e a primeira resposta positiva retoma a inscrição. Também é retomada se a criar de novo. Se continuar a falhar durante cerca de uma semana de tentativas, é removida. Com mais de 500 envios em espera por inscrição, ou 1000 por conta, os novos são ignorados. O seu endereço deve responder em 4 segundos; caso contrário, o envio conta como falhado. O campo
paused da inscrição indica se está em pausa, e avisamos por email uma vez por cada pausa.run.reason é um código fixo, nunca um texto: opted_out, app_off, timeout, step_failed, skipped ou vazio.As ligações
order_status_url e tracking_url podem abrir dados do destinatário sem início de sessão: trate-as como confidenciais.Se a ligação com que criou a inscrição expirar, os envios ficam em pausa e os eventos desse período não são recuperados: avisamos uma só vez, no painel e por email. Volte a ligá-la para os retomar.
Os testes da automação e as execuções ignoradas pelos seus controlos (antirrepetição, horários de envio) não enviam nada.
Recebe dados pessoais do contacto na sua ferramenta: continua responsável por eles e deve respeitar o estado
opted_out. Um contacto excluído não bloqueia o envio: contact.id é a chave para encontrar o contacto através das API. O corpo indica sempre contact.opted_out e contact.marketing_consent, e run.skipped_for_opt_out é verdadeiro se um passo ou a execução foram ignorados por exclusão. Não contém textos das conversas.Um email falhado pode enviar tanto
run_completed como run_failed para a mesma execução: o passo que coloca o email em fila fecha a execução e, se o email falhar depois, a execução passa a falhada.A inscrição é interrompida se revogar a ligação ou a chave API com que foi criada. Os envios também param com a conta suspensa, o plano expirado ou sem acesso à API.
Parâmetros
5 · 1 obrigatórios
url
obrigatório
Endereço https público.
events
opcional
Um ou mais de
run_started, run_completed, run_failed. Predefinição: run_started.
automation_id
opcional
Vazio = todas as automações da conta.
label
opcional
Um nome para a reconhecer.
include_event_data
opcional
Inclui os dados do evento que iniciou a regra, em
data.hook_data, além de data.payment_link e data.deal_name. Desligado por predefinição: desligado, estes campos não existem. Ligado, são removidas as credenciais e os campos de texto livre conhecidos (body, message, comment, note, description, ticket, assignee, reason), também os aninhados. Pode conter dados pessoais e outros dados dos sistemas ligados, sob a sua responsabilidade. Com o mesmo parâmetro, GET /api/automations/hooks/sample mostra um exemplo que inclui estes campos.
Precisa de ajuda com a integração? info@sendapp.live