curl --request POST \
--url https://api.ararahq.com/hooks/a/{token} \
--header 'Content-Type: application/json' \
--data '
{
"phone": "5511999999999"
}
'{
"referenceId": "pedido-1042",
"status": "paid",
"cardUpdated": true,
"runResumed": true
}{
"runId": "7c1d2e90-4b3a-4c8e-9f21-5a6b7c8d9e01",
"status": "started"
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}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
referenceIdestatusna raiz: atualiza o pagamento de uma cobrança já enviada (200), e a execução segue pelo ramopaidouunpaiddo passowait_payment.
Corpo de até 64 KB. Guia completo em Link da automação e pagamento.
curl --request POST \
--url https://api.ararahq.com/hooks/a/{token} \
--header 'Content-Type: application/json' \
--data '
{
"phone": "5511999999999"
}
'{
"referenceId": "pedido-1042",
"status": "paid",
"cardUpdated": true,
"runResumed": true
}{
"runId": "7c1d2e90-4b3a-4c8e-9f21-5a6b7c8d9e01",
"status": "started"
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}{
"error": {
"code": "INSUFFICIENT_FUNDS",
"message": "Saldo insuficiente.",
"details": {}
}
}Headers
Assinatura do corpo. Obrigatória quando a assinatura do link está ligada.
Evita iniciar a mesma execução duas vezes. Use o id do evento no seu sistema (ex. o número do pedido).
Path Parameters
Token do link (ara_hook_...), copiado da tela da automação ou do campo hook.url.
Body
- Iniciar execução
- Atualizar pagamento
Telefone do cliente, com DDI.
"5511999999999"
Variáveis da execução, usadas como {{nome}} nos passos.
Show child attributes
Show child attributes
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.