---
title: "Acionar automação pelo link"
method: POST
path: "/hooks/a/{token}"
tags: ["Automações"]
---

# Acionar automação pelo link

`POST /hooks/a/{token}`

## Request

- Base URL: `https://api.ararahq.com`
- URL: `https://api.ararahq.com/hooks/a/{token}`
- 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)

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](/automacoes-webhook).

## Path parameters

- `token` string, required

## Headers

- `X-Arara-Signature` string
- `Idempotency-Key` string

## Request body

- union
  - HookStartRequest
    - `phone` string, required: Telefone do cliente, com DDI.
    - `variables` object, nullable: Variáveis da execução, usadas como `{{nome}}` nos passos.
    - `charge` object, nullable: Cobrança que o passo de cobrança da automação vai enviar. `referenceId` é o seu número da cobrança: é com ele que você avisa o pagamento depois. Campos em [Link da automação e pagamento](/automacoes-webhook).
  - HookPaymentUpdateRequest
    - `referenceId` string, required: O mesmo `charge.referenceId` enviado ao iniciar.
    - `status` string, required: Novo estado da cobrança, ex.: `paid`.

## Response `200`

Pagamento atualizado

- HookPaymentUpdated
  - `referenceId` string, required
  - `status` string, required
  - `cardUpdated` boolean, required: `true` quando a janela de 24h permitiu atualizar o cartão no WhatsApp.
  - `runResumed` boolean, required: `true` quando havia uma execução esperando esse pagamento.

## Other responses

- `202`: Execução iniciada
- `400`: `HOOK_PAYLOAD_INVALID`, `INVALID_CHARGE` ou `INVALID_CHARGE_STATUS`.
- `401`: `HOOK_SIGNATURE_INVALID`: assinatura ausente ou errada com a assinatura ligada.
- `403`: `HOOK_SETTLEMENT_SIGNATURE_REQUIRED`: a baixa de pagamento exige a assinatura ligada.
- `404`: `HOOK_NOT_FOUND` (token inexistente ou trocado) ou `CHARGE_NOT_FOUND`.
- `409`: `AUTOMATION_INACTIVE` (automação desligada), `CHARGE_AMOUNT_MISMATCH` ou `CHARGE_ALREADY_SETTLED`.
- `413`: `HOOK_PAYLOAD_TOO_LARGE`: corpo acima de 64 KB.
- `429`: Limite de chamadas do link. Respeite `Retry-After`.

## Changes

- **2026-10-12** `d576cd28afc0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ararahq/apis/ararahq-api/changes/hooks/a/:token/post.md)

---

[API](https://skmtc.dev/ararahq/apis/ararahq-api.md) - [All operations](https://skmtc.dev/ararahq/apis/ararahq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ararahq/apis/ararahq-api/revisions/d576cd28afc0?raw)