NewAn AI receptionist that answers 24/7
Skip to content
Start free trial

Developers

Build on Arraxis.

A REST API to create and read leads, move stages and add notes, and webhooks that tell your systems the moment leads and appointments change.

Read the API docsUse Zapier or Make

POST /api/v1/leads

curl https://app.arraxis.site/api/v1/leads \  -H "Authorization: Bearer arx_live_…" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: typeform-8812" \  -d '{    "name": "Alex Morgan",    "phone": "+1 555 0100",    "email": "alex.morgan@example.com",    "service": "Consultation",    "source": "api"  }'
Example request and responses. Your key starts with arx_live_.

The basics

JSON, snake_case, no surprises.

Send the key as a Bearer token. Errors follow RFC 9457, so every failure says what to fix.

  • Keys and scopes

    Create keys in Arraxis with only the scopes each app needs: leads:read, leads:write and hooks:manage.

  • 120 requests a minute

    Per key. A 429 answer tells you how many seconds to wait.

  • Safe to retry

    Send an Idempotency-Key with a new lead, and a retry never creates it twice.

  • Signed webhooks

    Every event is signed with HMAC-SHA256 (Standard Webhooks), so you can check it came from Arraxis.

  • Same rules as every source

    Leads from the API get the same duplicate checks, assignment and notifications as any other source.

  • OpenAPI docs

    Every endpoint and event, documented at app.arraxis.site/docs/api.

Endpoints

Everything a lead needs.

All under https://app.arraxis.site/api/v1.

Full reference
  • POST/leadsCreate a lead
  • GET/leadsList leads, newest first
  • GET/leads/{id}One lead
  • POST/leads/{id}/stageMove a lead to a stage
  • POST/leads/{id}/notesAdd a note to a lead
  • GET/stagesThe stages of your pipeline
  • GET/sourcesYour lead sources
  • GET/fieldsYour custom lead fields
  • POST/hooksSubscribe an address to events
  • DELETE/hooks/{id}Unsubscribe an address

Webhooks

Outgoing webhook events

Point a webhook at your own endpoint, Zapier or Make, and receive these events as they happen.

Lead events

  • lead.created
  • lead.updated
  • lead.assigned
  • lead.stage_changed
  • lead.merged
  • lead.reinquiry
  • lead.note_added

Appointment events

  • appointment.booked
  • appointment.confirmed
  • appointment.rescheduled
  • appointment.cancelled
  • appointment.completed
  • appointment.no_show
API and webhooks integrationZapier and Make

Growth, accounted for.

Your next lead is on its way. Be ready for it.

Connect your lead sources and switch on your follow-ups. Try everything free for 14 days.

Start free trialBook a demo
  • 14 days free
  • No card needed
  • Cancel anytime