Astrify FlowsAstrify FlowsMeta Business Partner

For developers

REST API and webhooks to integrate Astrify

Create leads, send messages, work on boards and trigger Workflows from your system, receive data by webhook and call any API in the middle of a flow, with scoped keys and OpenAPI documentation.

  • OpenAPI 3.1 and Postman
  • Scoped keys
  • From Growth up

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

    routes in the API, from leads and messages to boards and proposals

  • 16

    resources with a read or write scope per key

  • 120

    requests per minute per key

  • 20

    active keys per company, each with its own usage log

REST API

What the API does

Pick a resource and see some routes.

Leads and pipeline

Create and update leads, merge duplicates, import in bulk and log activities and notes. The pipeline and stages are read through the API.

  • Create, list, update, delete and merge leads
  • Bulk import and duplicate search
  • Activities, notes, participants and items of the deal
  • Pipelines, stages, sources and loss reasons (read)

api2.astrify.com.br/v1

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

API keys

Each integration with its own key

Keys are created in Settings › Open API and sent in the Authorization header. They act as the person who created them and stop working if that person is deactivated.

  • 01

    Scope per resource

    Each key can only read or write what you select: leads, contacts, boards, messages and the rest.

  • 02

    Validity and IPs

    Validity from 1 to 730 days and a list of up to 20 allowed IPs.

  • 03

    Shown once

    The key is shown only when you create it; Astrify stores only a signature of it.

  • 04

    Rotate and revoke

    Rotate the key without stopping the integration and revoke it instantly, with a usage log for each one.

Inbound webhook

Your system notifies, the Workflow acts

The “Receive webhook” trigger gives the Workflow its own address. Send the JSON from your system, n8n, Make or Zapier, find the lead by email or phone and follow the flow. In listen mode, Astrify shows the first payload so you can map the fields before turning it on.

  • GET, POST, PUT and PATCH, up to 256 KB
  • 2-minute listen mode to see the real payload
  • Last 50 events stored per trigger
  • Up to 120 calls per minute per address

POST /api/webhooks/workflow/{token}

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

From Astrify to your system

Two paths, depending on what you need to know.

In the Workflow

HTTP request and Fire webhook

Any trigger (lead changed stage, proposal accepted, order delivered) can call your system in the middle of the flow and use the response in the next blocks.

  • GET, POST, PUT, PATCH and DELETE with headers and a JSON body
  • Lead variables in the URL and the body
  • Reply saved in a variable for the If/Else
  • Wait for the reply, or fire and move on

Outbound webhooks

Email marketing events

Register up to 10 endpoints in Settings › Webhooks and receive every event signed, with retries and a delivery history.

  • email.opened
  • email.clicked
  • email.replied
  • email.unsubscribed
  • email.bounced
  • email.complaint
  • email.list_joined
  • HMAC-SHA256 signature in the X-Astrify-Signature header
  • Retries after 1 min, 5 min, 30 min, 2 h and 6 h
  • History with resend and a test button

Documentation

OpenAPI, Postman and the guide on the platform

The OpenAPI 3.1 specification and the Postman collection are public at api2.astrify.com.br/v1/openapi.json and /v1/postman.json. Inside the platform, the documentation page explains authentication, scopes, errors and examples for each route.

Tools

n8n, Make and Zapier with no paid connector

Use those tools' HTTP request node with your key, and their webhook in the “Fire webhook” block.

  • n8n
  • Make
  • Zapier
Channel tokens and webhook secrets are encrypted, internal addresses are blocked in requests that leave the platform and the API respects the role permissions of whoever created the key.

Plans

API on each plan

The REST API and keys start on Growth. The “Receive webhook” trigger and the request blocks are on every plan, inside Workflows.

PlanPer monthREST APIReceive webhook and HTTP in the Workflow
Starter FreeFree—Yes
LiteR$ 197,90—Yes
GrowthR$ 397,90YesYes
ProR$ 797,90YesYes
ScaleR$ 1.497,90YesYes

Per month, in Brazilian reais (BRL); on annual you pay for 10 months and use 12. See all plans

Keep exploring

Frequently asked questions

What developers ask before integrating.

Yes, from Growth up: a REST API with about 128 routes for leads, contacts, pipelines, tags, products, proposals, WhatsApp messages, conversations, Workflows, campaigns, email, teams, tasks, boards and notifications.
With a key created in Settings › Open API, sent in the Authorization: Bearer header. Each key has a scope per resource (read or write), a validity of 1 to 730 days, an optional IP allowlist and a usage log. It is shown only once and can be rotated or revoked.
120 requests per minute per key, with a 429 response and the wait time when you go over. Each company can have up to 20 active keys.
Through the API's POST /v1/leads route, or through a Workflow's “Receive webhook” trigger, which gives your system, n8n, Make or Zapier an address of its own to send the data to. The old leads webhook with an x-api-key no longer exists.
Outbound webhooks send email marketing events (opened, clicked, replied, unsubscribed, bounced, complaint and joined the list), signed with HMAC-SHA256 and with retries. To notify your system of changes in the pipeline, proposals or orders, use the “Fire webhook” or “HTTP request” block in a Workflow.
The OpenAPI 3.1 specification and the Postman collection are public at api2.astrify.com.br/v1/openapi.json and /v1/postman.json, and the platform has a documentation page with authentication, scopes, errors and examples.
Astrify Flows

AAstrifychattingwiththesystemof theyourcompany.

Try Workflows with webhooks on the free plan and unlock the API from Growth up.