> ## Documentation Index > Fetch the complete documentation index at: https://docs.api.aura-app.ai/llms.txt > Use this file to discover all available pages before exploring further. # Ingest an external funnel event ## OpenAPI ````yaml openapi.json POST /v1/funnel/events openapi: 3.1.0 info: contact: email: support@aura-app.ai name: Aura Support description: >- # Aura Partner Integrations API > **Alpha Release** - This API is under active development. Endpoints, request/response schemas, and behaviors may change without prior notice. We recommend pinning to specific response fields you need and handling unknown fields gracefully. Enterprise REST API for external partner integrations including commission platforms, external mobile apps, and client booking widgets. ## MCP Connector Aura also exposes a **Model Context Protocol** server at `/mcp` so AI assistants (Claude, ChatGPT) can answer questions about a user's own sales data. If you are building an assistant integration rather than a server-to-server one, that is almost certainly the surface you want — it is task-shaped ("prep me for my next call") rather than resource-shaped, and it handles auth per-user. Read-only. OAuth 2.1 + PKCE, with Clerk as the authorization server; discover it from `/.well-known/oauth-protected-resource`. Setup guide: https://docs.api.aura-app.ai/mcp-connector ## Authentication Authenticated endpoints support two authentication methods: **1. API Key (for partners and integrations):** ``` Authorization: Bearer aura_pk_live_xxxxxxxxxxxxxxxx ``` Get your API key from the Aura dashboard at Settings > API Keys. **2. Clerk JWT (for mobile and web apps):** ``` Authorization: Bearer ``` Use Clerk's authentication SDK to obtain a JWT token with org claims. ## Rate Limiting - **Per API Key:** 100 requests/minute - **Per Organization:** 1000 requests/minute Rate limit headers are included in all responses: - `X-RateLimit-Limit`: Maximum requests allowed - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when limit resets These counters are held per serving instance, so under concurrency the effective ceiling is higher than the number above and the headers describe one instance's view rather than a global total. Treat a 429 as backpressure to obey and pace your client to the documented rate — but do not rely on us to reject your 101st request, and do not derive a global remaining-quota figure from the headers. The limit may become globally enforced without notice, so a client that stays within it will not be affected when that happens. ## Pagination List endpoints support cursor-based pagination: - `limit`: Number of results per page (default: 50, max: 100) - `cursor`: Opaque cursor for next page ## Error Handling All errors follow a standard format: ```json { "success": false, "error": "Error message", "code": "ERROR_CODE" } ``` Common HTTP status codes: - **400** Bad Request - Invalid input (`VALIDATION_ERROR`) - **401** Unauthorized - Missing or invalid API key (`AUTHENTICATION_ERROR`) - **402** Payment Required - The key is valid, but the organization's subscription is not active (`PAYMENT_REQUIRED`). Every authenticated endpoint can return this. Retrying will not help until the account's payment method is updated in Aura; surface it to the account owner rather than treating it as an auth failure. - **403** Forbidden - Insufficient permissions (`AUTHORIZATION_ERROR`) - **404** Not Found - Resource not found (`NOT_FOUND`) - **409** Conflict - Resource state prevents the operation (`CONFLICT`) - **413** Payload Too Large - Request body exceeds 256KB (`PAYLOAD_TOO_LARGE`) - **429** Too Many Requests - Rate limit exceeded (`RATE_LIMIT_EXCEEDED`) - **500** Internal Server Error - Server error (`INTERNAL_ERROR`) ## Webhooks Subscribe to real-time events using the Webhooks API. All webhook payloads are signed with HMAC-SHA256 for security verification. Delivery is at-least-once. Every payload carries an `idempotency_key` that is stable across retries of the same event, so you can enforce exactly-once with a `(subscription_id, idempotency_key)` unique constraint on your side. For full documentation, visit [docs.aura-app.ai/api](https://docs.aura-app.ai/api) license: name: Proprietary title: Aura Partner Integrations API version: 1.0.0-alpha servers: - description: Production url: https://api.aura-app.ai - description: Staging url: https://staging-api.aura-app.ai - description: Local Development url: http://localhost:3001 security: - bearerAuth: [] tags: - description: Lead management operations name: Leads - description: Call booking and management name: Calls - description: Booking link configuration (read-only) name: Booking Links - description: Product catalog (read-only) name: Products - description: Payment tracking (read-only) name: Payments - description: Public booking creation name: Bookings - description: Real-time event subscriptions and webhook management name: Webhooks - description: >- Team member information for commission attribution. **Alpha** - schema may change without notice. name: Team (Alpha) - description: >- Dashboard analytics, lead source attribution, and objection analysis. **Alpha** - schema may change without notice. name: Analytics (Alpha) - description: System endpoints (health checks) name: System paths: /v1/funnel/events: post: tags: - Funnel Events summary: Ingest an external funnel event requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalFunnelEvent' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/ExternalFunnelEventResponse' description: Event accepted '400': content: application/json: schema: $ref: '#/components/schemas/MiddlewareErrorResponse' description: Request validation failed headers: X-Request-Id: description: Request identifier for support schema: type: string '401': content: application/json: schema: $ref: '#/components/schemas/MiddlewareErrorResponse' description: Missing or invalid API key headers: X-Request-Id: description: Request identifier for support schema: type: string '402': content: application/json: schema: $ref: '#/components/schemas/MiddlewareErrorResponse' description: The organization's subscription is not active headers: X-Request-Id: description: Request identifier for support schema: type: string '403': content: application/json: schema: properties: code: type: string error: type: string success: enum: - false type: boolean required: - success - error - code type: object description: Origin or scope rejected '408': content: application/json: schema: $ref: '#/components/schemas/MiddlewareErrorResponse' description: >- The request exceeded its processing time limit. Check the outcome before retrying a write headers: X-Request-Id: description: Request identifier for support schema: type: string '413': content: application/json: schema: $ref: '#/components/schemas/MiddlewareErrorResponse' description: The request body exceeds 256KB headers: X-Request-Id: description: Request identifier for support schema: type: string '429': content: application/json: schema: $ref: '#/components/schemas/MiddlewareErrorResponse' description: Rate limit exceeded. Wait before retrying headers: Retry-After: description: Seconds to wait before retrying schema: type: string X-RateLimit-Limit: description: Requests allowed in the current window schema: type: string X-RateLimit-Remaining: description: Requests remaining in the current window schema: type: string X-RateLimit-Reset: description: Window reset as a Unix timestamp schema: type: string X-Request-Id: description: Request identifier for support schema: type: string '500': content: application/json: schema: $ref: '#/components/schemas/MiddlewareErrorResponse' description: >- Unexpected server failure. Include the request identifier when contacting support headers: X-Request-Id: description: Request identifier for support schema: type: string security: - bearerAuth: [] components: schemas: ExternalFunnelEvent: additionalProperties: false properties: advertising: additionalProperties: false properties: eventId: maxLength: 128 minLength: 1 type: string eventSourceUrl: format: uri maxLength: 2000 type: string eventTime: exclusiveMinimum: true minimum: 0 type: integer fbp: maxLength: 500 nullable: true type: string required: - eventId - eventTime - eventSourceUrl type: object attribution: additionalProperties: false properties: fbclid: maxLength: 500 nullable: true type: string gclid: maxLength: 500 nullable: true type: string referrer: format: uri maxLength: 2000 nullable: true type: string utmCampaign: maxLength: 300 nullable: true type: string utmContent: maxLength: 300 nullable: true type: string utmMedium: maxLength: 200 nullable: true type: string utmSource: maxLength: 200 nullable: true type: string utmTerm: maxLength: 300 nullable: true type: string type: object consentState: enum: - granted - not_required type: string deviceClass: enum: - mobile - tablet - desktop - unknown type: string eventId: maxLength: 128 minLength: 8 type: string eventType: enum: - page_view - engaged_visit - cta_click - form_start - booking_open - lead_submission - booking_completion - purchase_completion - purchase_refund type: string funnelId: maxLength: 128 minLength: 1 type: string gpc: type: boolean identity: additionalProperties: false properties: email: format: email maxLength: 320 type: string firstName: maxLength: 100 type: string lastName: maxLength: 100 type: string phone: maxLength: 40 type: string type: object occurredAt: format: date-time type: string pagePath: maxLength: 2000 type: string previousPage: maxLength: 2000 nullable: true type: string properties: additionalProperties: anyOf: - maxLength: 500 type: string - type: number - type: boolean - nullable: true type: object sourceDomain: maxLength: 253 minLength: 1 type: string version: anyOf: - enum: - 1 type: number - enum: - 2 type: number visitorId: maxLength: 128 minLength: 8 type: string required: - version - eventId - eventType - visitorId - funnelId - sourceDomain - pagePath - occurredAt - consentState - deviceClass type: object ExternalFunnelEventResponse: properties: data: properties: accepted: type: boolean duplicate: type: boolean sessionId: type: string required: - accepted - duplicate - sessionId type: object success: enum: - true type: boolean required: - success - data type: object MiddlewareErrorResponse: properties: code: type: string error: type: string requestId: type: string success: enum: - false type: boolean required: - success - error - code type: object ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.