Guide

Quickstart

Create a key, validate it with /me, then make your first read.

1. Create a scoped API key

In the STATXE dashboard, create a key for the public_api audience. Select only the scopes your integration needs. Keys look like stx_live_… (production) or stx_test_… (non-production). Copy the secret once and store it in your secret manager — it is not shown again.

2. Validate with GET /me

Use GET /api/v1/me as a health check before wiring the rest of your integration. A valid key returns org context, key id, scopes, and rate-limit metadata.

export STATXE_API_KEY="stx_live_xxx"
export STATXE_API_BASE_URL="https://api.statxe.com"

curl "$STATXE_API_BASE_URL/api/v1/me" \
  -H "Authorization: Bearer $STATXE_API_KEY"

3. Make one read request

Start with contacts, inbox threads, broadcasts, or webhook delivery logs. Confirm scopes and pagination before adding writes.

curl "$STATXE_API_BASE_URL/api/v1/contacts?limit=20" \
  -H "Authorization: Bearer $STATXE_API_KEY"

4. Add idempotent writes and webhooks

For POST, PATCH, and DELETE, send an Idempotency-Key header. Subscribe to signed webhooks before going live so your system can react to deliveries and compliance events.