Astrify FlowsAstrify FlowsMeta Business Partner

Para desenvolvedores

API REST e webhooks para integrar a Astrify

Crie leads, mande mensagens, mexa nos quadros e dispare Workflows a partir do seu sistema, receba dados por webhook e chame qualquer API no meio de um fluxo, com chaves por escopo e documentação OpenAPI.

  • OpenAPI 3.1 e Postman
  • Chaves com escopo
  • A partir do Growth

Terminal

curl -X POST https://api2.astrify.com.br/v1/leads \
  -H "Authorization: Bearer astrify_7f3k…" \
  -H "Content-Type: application/json" \
  -d '{
    "nome": "Paula Mendes",
    "telefone": "+5511955550000",
    "email": "paula@email.com"
  }'

201 Created

{
  "id": "ld_8c21…",
  "nome": "Paula Mendes",
  "etapa": "Novo lead",
  "funil": "Vendas"
}
  • 128

    rotas na API, de leads e mensagens a quadros e propostas

  • 16

    recursos com escopo de leitura ou escrita por chave

  • 120

    requisições por minuto em cada chave

  • 20

    chaves ativas por empresa, cada uma com o seu registro de uso

API REST

O que a API faz

Escolha o recurso e veja algumas rotas.

Leads e funil

Crie e atualize leads, junte duplicados, importe em lote e registre atividades e notas. O funil e as etapas são lidos pela API.

  • Criar, listar, atualizar, excluir e juntar leads
  • Importação em lote e busca de duplicados
  • Atividades, notas, participantes e itens do negócio
  • Funis, etapas, origens e motivos de perda (leitura)

api2.astrify.com.br/v1

  • POST/leads
  • GET/leads
  • PATCH/leads/{lead_id}
  • POST/leads/importar-lote
  • GET/funis/{funil_id}/etapas

Chaves de API

Cada integração com a sua chave

As chaves são criadas em Configurações › API aberta e enviadas no cabeçalho Authorization. Elas agem como quem criou e param se essa pessoa for desativada.

  • 01

    Escopo por recurso

    Cada chave só lê ou escreve o que você marcar: leads, contatos, quadros, mensagens e o resto.

  • 02

    Validade e IPs

    Validade de 1 a 730 dias e lista de até 20 IPs autorizados.

  • 03

    Mostrada uma vez

    A chave aparece só na criação; a Astrify guarda apenas uma assinatura dela.

  • 04

    Girar e revogar

    Troque a chave sem parar a integração e revogue na hora, com o registro de uso de cada uma.

Webhook de entrada

O seu sistema avisa, o Workflow age

O gatilho “Receber webhook” dá um endereço próprio ao Workflow. Mande o JSON do seu sistema, do n8n, do Make ou do Zapier, encontre o lead pelo e-mail ou telefone e siga o fluxo. No modo escuta, a Astrify mostra o primeiro envio para você mapear os campos antes de ligar.

  • GET, POST, PUT e PATCH, até 256 KB
  • Modo escuta de 2 minutos para ver o envio real
  • Últimos 50 eventos guardados em cada gatilho
  • Até 120 chamadas por minuto em cada endereço

POST /api/webhooks/workflow/{token}

{
  "evento": "pagamento_aprovado",
  "cliente": {
    "nome": "João Prado",
    "email": "joao@pradoalimentos.com.br"
  },
  "valor": 1290.00
}

Da Astrify para o seu sistema

Dois caminhos, conforme o que você precisa saber.

No Workflow

Requisição HTTP e Disparar webhook

Qualquer gatilho (lead mudou de etapa, proposta aceita, pedido entregue) pode chamar o seu sistema no meio do fluxo e usar a resposta nos próximos blocos.

  • GET, POST, PUT, PATCH e DELETE com cabeçalhos e corpo JSON
  • Variáveis do lead na URL e no corpo
  • Resposta salva em variável para o Se/Senão
  • Esperar a resposta ou disparar e seguir

Webhooks de saída

Eventos do e-mail marketing

Cadastre até 10 endereços em Configurações › Webhooks e receba cada evento assinado, com novas tentativas e o histórico de entregas.

  • email.opened
  • email.clicked
  • email.replied
  • email.unsubscribed
  • email.bounced
  • email.complaint
  • email.list_joined
  • Assinatura HMAC-SHA256 no cabeçalho X-Astrify-Signature
  • Novas tentativas em 1 min, 5 min, 30 min, 2 h e 6 h
  • Histórico com reenvio e botão de teste

Documentação

OpenAPI, Postman e o guia na plataforma

A especificação OpenAPI 3.1 e a coleção do Postman ficam abertas em api2.astrify.com.br/v1/openapi.json e /v1/postman.json. Dentro da plataforma, a página de documentação explica autenticação, escopos, erros e exemplos de cada rota.

Ferramentas

n8n, Make e Zapier sem conector pago

Use o nó de requisição HTTP dessas ferramentas com a sua chave, e o webhook delas no bloco “Disparar webhook”.

  • n8n
  • Make
  • Zapier
Tokens dos canais e segredos dos webhooks ficam criptografados, os endereços internos são bloqueados nas requisições que saem da plataforma e a API respeita as permissões do cargo de quem criou a chave.

Planos

API em cada plano

A API REST e as chaves entram a partir do Growth. O gatilho “Receber webhook” e os blocos de requisição estão em todos os planos, dentro dos Workflows.

PlanoPor mêsAPI RESTReceber webhook e HTTP no Workflow
Starter FreeGrátis—Sim
LiteR$ 197,90—Sim
GrowthR$ 397,90SimSim
ProR$ 797,90SimSim
ScaleR$ 1.497,90SimSim

Por mês, em reais; no anual você paga 10 meses e usa 12. Ver todos os planos

Continue por aqui

Perguntas frequentes

O que desenvolvedores perguntam antes de integrar.

Sim, a partir do Growth: uma API REST com cerca de 128 rotas para leads, contatos, funis, etiquetas, produtos, propostas, mensagens de WhatsApp, conversas, Workflows, campanhas, e-mail, equipes, tarefas, quadros e notificações.
Com uma chave criada em Configurações › API aberta, enviada no cabeçalho Authorization: Bearer. Cada chave tem escopo por recurso (leitura ou escrita), validade de 1 a 730 dias, lista opcional de IPs e registro de uso. Ela aparece só uma vez e pode ser girada ou revogada.
120 requisições por minuto em cada chave, com resposta 429 e o tempo de espera quando passa disso. Cada empresa pode ter até 20 chaves ativas.
Pela rota POST /v1/leads da API, ou pelo gatilho “Receber webhook” de um Workflow, que dá um endereço próprio para o seu sistema, o n8n, o Make ou o Zapier mandarem os dados. O antigo webhook de leads com chave x-api-key não existe mais.
Os webhooks de saída enviam os eventos do e-mail marketing (abriu, clicou, respondeu, cancelou a inscrição, devolvido, reclamação e entrou na lista), assinados com HMAC-SHA256 e com novas tentativas. Para avisar o seu sistema de mudanças no funil, nas propostas ou nos pedidos, use o bloco “Disparar webhook” ou “Requisição HTTP” num Workflow.
A especificação OpenAPI 3.1 e a coleção do Postman ficam abertas em api2.astrify.com.br/v1/openapi.json e /v1/postman.json, e a plataforma tem uma página de documentação com autenticação, escopos, erros e exemplos.
Astrify Flows

AAstrifyconversandocomosistemadasuaempresa.

Teste os Workflows com webhook no plano grátis e libere a API a partir do Growth.