Core APIs
Automations
Inbound triggers that kick off Niah work from your systems — with run history and optional callbacks.
Two ways to trigger
| Method | Auth | When to use |
|---|---|---|
post /v1/automations/{id}/trigger |
API key + automations:trigger |
Your backend already has a Niah key |
post /v1/inbound/{token} |
Secret token in the path (no Bearer) | Third-party webhooks / Zapier-style integrations |
Manage automations
| get | /v1/automations | List |
| post | /v1/automations | Create |
| get | /v1/automations/{id} | Details (includes trigger_token) |
| put | /v1/automations/{id} | Update |
| delete | /v1/automations/{id} | Delete |
Run history
get /v1/automations/{id}/runs and .../runs/{run_id} return status, linked consultation/pipe ids, callback delivery, and result payloads. Status: pending, running, completed, failed, cancelled.
bash
# Public ingress — token authenticates the call
curl -X POST "https://api.niah.si/v1/inbound/$TRIGGER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"external_ref": "crm-deal-123", "context": {"deal_size": 50000}}'
Prefer an
idempotency_key (or Idempotency-Key header) on triggers so retries never double-fire.
Previous← Webhooks
NextSCIM →