AIDA Zapier

O Zapier é um Destino (beta) que envia para um Zap cada documento aprovado no AIDA, para encaminhar os seus dados e o PDF para milhares de aplicações (Google Sheets, Slack, o seu ERP e muito mais).

Ligar o AIDA ao Zapier

1. No AIDA, abra o tipo de documento, adicione o destino Zapier e guarde.
2. Copie a chave do destino.
3. No Zapier, crie um Zap com o acionador AIDA → Document Approved. Cole a chave quando for pedida a ligação. A ligação tem o nome do tipo de documento.
4. Teste o acionador: o Zapier carrega como exemplos os três documentos processados mais recentes desse tipo. Aprove primeiro pelo menos um documento.
5. Adicione as ações de que precisa, mapeie os campos e publique o Zap.

A partir daí, cada documento aprovado com este destino é enviado para o Zap. O botão Abrir os seus Zaps no destino abre os seus Zaps no Zapier.

note

Cada destino Zapier alimenta um único Zap: ligar um novo Zap com a mesma chave substitui o anterior. Para alimentar vários Zaps, adicione vários destinos Zapier. Regenerar a chave desliga o Zap.

Se o Zap for desativado ou eliminado, o destino é desligado e as novas aprovações terminam com o erro zapierNotConnected até que um Zap seja ligado novamente.

---

Payload

Cada documento aprovado é enviado como um objeto JSON. Os registos de exemplo mostrados no Zapier têm o mesmo formato.

Campo	Tipo	Descrição
id	string	O ID do documento no AIDA.
documentName	string	O nome do documento.
documentConfigurationName	string	O nome do tipo de documento.
documentURL	string	Uma ligação permanente para ver o documento na aplicação web do AIDA.
downloadURL	string	Uma ligação temporária e segura para descarregar o PDF do documento. Expira ao fim de 7 dias.

As propriedades extraídas seguem as mesmas regras do destino Webhook: a chave é o Output Mapping da propriedade ou, se não estiver definido, a sua Etiqueta, os valores são convertidos no seu tipo JSON e as tabelas tornam-se arrays. Ao contrário do webhook, as datas são strings ISO-8601 em UTC (por exemplo 2025-10-14T00:00:00Z).

{
  "Invoice number": "INV-2025-042",
  "invoiceDate": "2025-10-14T00:00:00Z",
  "total": 122.00,
  "lines": [
    { "description": "Product A", "qty": 2, "unitPrice": 50.00 }
  ],
  "id": "12345",
  "documentName": "invoice-042.pdf",
  "documentConfigurationName": "Invoice",
  "documentURL": "https://www.aidacloud.com/app/web/archive/12345",
  "downloadURL": "https://api.aidacloud.com/asset/document/generated-auth-token"
}

---

Referência da API

A aplicação AIDA para o Zapier usa os seguintes endpoints. O URL base é https://api.aidacloud.com/api/v1/zapier.

Autenticação: cada pedido envia a chave do destino no cabeçalho X-API-Key. Uma chave em falta ou desconhecida devolve 401 Unauthorized.

Método	Caminho	Finalidade	Body	Resposta
GET	/me	Testa a ligação.	-	{ "id", "documentConfigurationId", "documentConfigurationName", "username" }
POST	/hooks	Subscreve o Zap (REST hook). O URL tem de começar por https://hooks.zapier.com/, caso contrário 400.	{ "hookUrl": "…" }	{ "id" }
DELETE	/hooks	Cancela a subscrição do Zap. Só desliga o destino se hookUrl for o atualmente ligado.	{ "hookUrl": "…" }	vazia
GET	/documents/sample	Devolve até três documentos processados recentemente do tipo de documento, no formato do payload.	-	array de payloads

Entrega: quando um documento é aprovado, o AIDA envia um HTTP POST com o payload para o hook subscrito, com Content-Type: application/json. Se o Zapier responder 410 Gone, o AIDA desliga o destino.