Workspace API keys require Growth+. Authenticate with a bearer token, respect rate limits, and verify outbound webhook signatures. Logged-in workspaces manage keys and webhooks inside the app.
Authorization: Bearer aivert_…
Rate limits: 120 req/min per API key, 300 req/min per session user. Exceeding returns HTTP 429 with Retry-After.
| Method | Path | Scope | Notes |
|---|---|---|---|
| GET | /api/v1/contacts | contacts:read | List contacts (?q=) |
| POST | /api/v1/contacts | contacts:write | Upsert contact by phoneE164 |
| GET | /api/v1/conversations | inbox:read | Recent conversations |
| POST | /api/v1/conversations/:id/messages | inbox:write | { "kind": "text", "text": "…" } or template |
| GET | /api/v1/templates | templates:read | Approved templates |
| POST | /api/v1/templates/send | inbox:write | Send approved template: { to, templateId|templateName, bodyParams[] } |
| GET | /api/v1/broadcasts | broadcasts:read | List broadcasts |
| POST | /api/v1/broadcasts | broadcasts:write | Create + enqueue broadcast |
| GET | /api/v1/orders | orders:read | Catalog orders |
curl -sS https://aivert.in/api/v1/contacts \ -H "Authorization: Bearer aivert_YOUR_KEY"
Send an approved template (also available as Copy Curl on each row in Templates → My Templates):
curl -sS -X POST https://aivert.in/api/v1/templates/send \
-H "Authorization: Bearer aivert_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+9198XXXXXXXX",
"templateName": "your_approved_template",
"language": "en",
"bodyParams": ["Value for {{1}}", "Value for {{2}}"]
}'Configure HTTPS endpoints in the app under Developers. Each delivery includes X-AiVert-Event and X-AiVert-Signature: sha256=<hmac> over the raw JSON body. Events: automation.matched, flow.submitted, commerce.order.created, message.inbound, broadcast.completed.
const crypto = require("crypto");
function verify(secret, rawBody, signatureHeader) {
const expected = "sha256=" + crypto
.createHmac("sha256", secret)
.update(rawBody, "utf8")
.digest("hex");
return expected === signatureHeader;
}AiVert, 14, PT Rajan Road, Narimedu, Madurai 625002