API Authentication

Generate API keys, manage scopes, and authenticate your requests securely.

3 min readAPI & Webhooks

Ayorax uses API keys for authentication. Keys can be scoped to specific resources and revoked at any time without affecting other integrations.

Creating an API key

Go to API Keys (Manager/Admin only).

Click New API Key.

Give the key a descriptive name (e.g. "Zapier integration").

Select scopes: Leads (read/write), Workflows (read/execute), Analytics (read), Webhooks (manage).

Click Create. Copy the key immediately — it is only shown once.

code

Scope	Access
leads:read	List and get leads
leads:write	Create, update, delete leads
workflows:read	List workflows
workflows:execute	Trigger workflow runs
analytics:read	Read analytics data
webhooks:manage	Register and delete webhooks

Never commit API keys to source code or expose them in frontend JavaScript. Use environment variables and server-side requests only.

API Overview

Introduction to the Ayorax REST API — authentication, base URL, and response format.

Rate Limits

API rate limit tiers, headers, and how to handle 429 responses gracefully.

Webhook Events

Subscribe to real-time events from Ayorax and receive HTTP POST payloads to your endpoint.

Was this article helpful?

API Overview

Webhook Events