Automações

Acionar automação pelo link

Link próprio de uma automação com gatilho webhook. Não usa chave de API: o token na URL é a credencial. Trate o link como segredo.

O mesmo link aceita dois corpos:

Com phone: inicia uma execução (202).
Com referenceId e status na raiz: atualiza o pagamento de uma cobrança já enviada (200), e a execução segue pelo ramo paid ou unpaid do passo wait_payment.

Corpo de até 64 KB. Guia completo em Link da automação e pagamento.

post/hooks/a/{token}

Request

Base URL
https://api.ararahq.com
Auth
none required
TypeScript
https://skmtc.dev/ararahq/apis/ararahq-api/docs/hooks/a/:token/post.ts
A function with typed inputs. Its response is checked against the schema.

tokenstring required

Token do link (ara_hook_...), copiado da tela da automação ou do campo hook.url.

X-Arara-Signaturestring

Assinatura do corpo. Obrigatória quando a assinatura do link está ligada.

Idempotency-Keystring

Evita iniciar a mesma execução duas vezes. Use o id do evento no seu sistema (ex. o número do pedido).

{
  "phone": "5511999999999"
}

Pagamento atualizado

referenceIdstring required

statusstring required

cardUpdatedboolean required

true quando a janela de 24h permitiu atualizar o cartão no WhatsApp.

runResumedboolean required

true quando havia uma execução esperando esse pagamento.