Aurinko provides a unified API platform that integrates email, calendar, contacts, and tasks across major services. Their solution enables developers to streamline inbox integration, automate workflows, and enhance productivity for enterprises. With a free trial and trusted by leading companies, Aurinko aims to simplify communication management through a single, consistent API layer, reducing development overhead and improving user experience.
Yoxel publishes 25 API contracts indexed on the APIs.io network, including Account API, Accounts API, Auth API, and 22 more. Tagged areas include Company, Integration, Email, Calendar, and Contacts.
The Yoxel catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.
Yoxel’s developer surface includes authentication, API reference, documentation, engineering blog, pricing, getting-started guide, and 24 more developer resources.
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/aurinko/"><img src="https://apis.io/badge/aurinko/card.svg" alt="Yoxel on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
MCP Server+12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship Ask about this →
Idempotency+9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented) Ask about this →
Delegated User Identity+6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented) Ask about this →
6 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.
Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
An account corresponds to an email address, mailbox, and/or calendar. When connecting to the Aurinko API, a specific access token gives you access to a specific account’s data.
These endpoints allow for account management outside the developer console interface. You can list, cancel, update, and delete accounts associated with your application.
Aurinko's Unified OAuth Flows are backed by providers’ OAuth2 flows (i.e. Google, Office 365, Salesforce, HubSpot,...) or by secure password-based authentications (i.e. MS Excha...
Booking profiles allow you to build calendar availability and meeting scheduling apps. List, create, update, and delete booking profiles associated with a calendar (Aurinko acco...
Contacts are objects within an address book, containing several pieces of information, such as email addresses, phone numbers, postal addresses, work place details.
Events are objects within a calendar, generally supporting all features of modern scheduling apps. Using the calendar APIs, your application can schedule events, send meeting in...
Follow-up rules allow you to define automatic email follow-up (drip) sequences and email templates. List, create, update, and delete follow-up rules associated with a mailbox ac...
Group Booking profiles allow you to build calendar availability and meeting scheduling for a group of accounts. List, create, update, and delete booking profiles associated with...
Messages contain several pieces of information, such as when a message was sent, the sender's address, to whom it was sent, and the message body. They can also contain files (at...
Service accounts represent admin/service/organization level connections. List, cancel, update, and delete service accounts associated with your application.
`User` is an Aurinko managed entity that your app can leverage to implement user session management. Multiple regular Aurinko accounts can be linked to a `User` however there is...
Webhooks allow your application to receive simple notifications when certain events occur. They essentially tell your application that it can run incremental syncs to obtain the...
aid: aurinko
name: Yoxel
accessModel:
pricing: paid
onboarding: unknown
trial: false
try_now: false
public: false
label: Paid
confidence: medium
source:
- plans
- authentication
- security
generated: '2026-11-13'
method: derived
image: https://www.aurinko.io/images/image-logo.png
description: Aurinko provides a unified API platform that integrates email, calendar, contacts, and tasks across major services.
Their solution enables developers to streamline inbox integration, automate workflows, and enhance productivity for enterprises.
With a free trial and trusted by leading companies, Aurinko aims to simplify communication management through a single,
consistent API layer, reducing development overhead and improving user experience.
url: https://raw.githubusercontent.com/api-evangelist/aurinko/refs/heads/main/apis.yml
x-type: company
x-source: harvest:g2-catalog
x-tier: profiled
x-tier-reason: enrichment pass 2026-10-19 (modular-v1; was harvest)
specificationVersion: '0.20'
created: '2026-10-19'
modified: '2026-10-19'
tags:
- Company
- Integration
- Email
- Calendar
- Contacts
- Task
tags_raw:
- Company
- Integration
- Email
- Calendar
- Contacts
- Tasks
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
- FN: APIs.json
email: info@apis.io
common:
- type: AgenticAccess
url: agentic-access/aurinko-agentic-access.yml
- type: Plans
url: plans/aurinko-plans-pricing.yml
- type: Spectral
url: rules/aurinko-rules.yml
- type: JSONLD
url: json-ld/aurinko-context.jsonld
- type: Vocabulary
url: vocabulary/aurinko-vocabulary.yml
- type: AgentSkill
url: skills/_index.yml
- type: DataModel
url: data-model/aurinko-data-model.yml
- type: Authentication
url: authentication/aurinko-authentication.yml
- type: ErrorCatalog
url: errors/aurinko-problem-types.yml
- type: Conformance
url: conformance/aurinko-conformance.yml
- type: LLMsTxt
url: llms/aurinko-llms.txt
- type: WellKnown
url: well-known/aurinko-well-known.yml
- type: Hosts
url: hosts/aurinko-hosts.yml
- type: Vendors
url: vendors/aurinko-vendors.yml
- type: SDKs
url: packages/aurinko-packages.yml
- type: Packages
url: packages/aurinko-packages.yml
- type: TermsOfService
url: https://www.aurinko.io/terms/
- type: PrivacyPolicy
url: https://www.aurinko.io/privacy-policy
- type: APIReference
url: https://apirefs.aurinko.io/
- type: DomainSecurity
url: security/aurinko-domain-security.yml
- type: Website
url: https://www.aurinko.io/
- type: Documentation
url: https://docs.aurinko.io/
- type: Blog
url: https://www.aurinko.io/blog/
- type: Pricing
url: https://www.aurinko.io/pricing/
- type: GettingStarted
url: https://www.aurinko.io/unified-api/
- type: UsageTerms
url: terms/aurinko-terms-of-service.yml
- type: DataProcessing
url: privacy/aurinko-privacy-policy.yml
- type: Eligibility
url: eligibility/aurinko-eligibility.yml
- type: AIPreferences
url: ai-preferences/aurinko-ai-preferences.yml
- type: DataLicense
url: data-license/aurinko-data-license.yml
apis:
- aid: aurinko:aurinko-account-api
name: Yoxel Account API
description: An account corresponds to an email address, mailbox, and/or calendar. When connecting to the Aurinko API, a
specific access token gives you access to a specific account’s data.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Account
properties:
- type: OpenAPI
url: openapi/aurinko-account-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-api-account-out-dto-schema.json
- aid: aurinko:aurinko-accounts-api
name: Yoxel Accounts API
description: These endpoints allow for account management outside the developer console interface. You can list, cancel,
update, and delete accounts associated with your application.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Account
tags_raw:
- Accounts
properties:
- type: OpenAPI
url: openapi/aurinko-accounts-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-api-account-out-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-api-account-in-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-accounts-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-account-save-result-schema.json
- aid: aurinko:aurinko-auth-api
name: Yoxel Auth API
description: 'Aurinko''s Unified OAuth Flows are backed by providers’ OAuth2 flows (i.e. Google, Office 365, Salesforce,
HubSpot,...)
or by secure password-based authentications (i.e. MS Exchange, IMAP accounts). The following three flows are supported:
1. Account OAuth - User delegated authorization that produces an Aurinko account and an access token.
2. Service Account OAuth - Admin/Org-level authorization that produces an Auirnko service account and an access token.
3. User OAuth - User delegated authorization that produces an Aurinko User, its primary account, and a user session token
or cookie.
See [this user guide](https://docs.aurinko.io/authentication/authentication-flow) for more information.'
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Authentication
tags_raw:
- Auth
properties:
- type: OpenAPI
url: openapi/aurinko-auth-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-account-save-result-schema.json
- type: JSONSchema
url: json-schema/aurinko-prepared-auth-token-schema.json
- aid: aurinko:aurinko-availability-api
name: Yoxel Availability API
description: See meeting time availability according to the group booking profile configuration. Book a meeting for an account
or one of users in a group.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Availability
properties:
- type: OpenAPI
url: openapi/aurinko-availability-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-booking-times-out-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-create-meeting-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-booking-available-profiles-in-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-create-meeting-response-schema.json
- type: JSONSchema
url: json-schema/aurinko-booking-available-profiles-out-dto-schema.json
- aid: aurinko:aurinko-booking-api
name: Yoxel Booking API
description: Booking profiles allow you to build calendar availability and meeting scheduling apps. List, create, update,
and delete booking profiles associated with a calendar (Aurinko account). Gather availability information from a calendar
and find time slots when the calendar owner is available. Schedule events for a calendar owner.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Booking
properties:
- type: OpenAPI
url: openapi/aurinko-booking-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-booking-out-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-booking-in-dto-schema.json
- aid: aurinko:aurinko-calendars-api
name: Yoxel Calendars API
description: Each account connected to Aurino can have zero or more calendars, and each calendar has a collection of individual
events.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Calendar
tags_raw:
- Calendars
properties:
- type: OpenAPI
url: openapi/aurinko-calendars-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-calendar-schema.json
- type: JSONSchema
url: json-schema/aurinko-calendars-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-calendar-create-schema.json
- type: JSONSchema
url: json-schema/aurinko-calendar-update-schema.json
- aid: aurinko:aurinko-calsync-api
name: Yoxel Cal Sync API
description: Sync/delta methods.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- CalSync
properties:
- type: OpenAPI
url: openapi/aurinko-calsync-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-deleted-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-events-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-sync-status-schema.json
- aid: aurinko:aurinko-contacts-api
name: Yoxel Contacts API
description: Contacts are objects within an address book, containing several pieces of information, such as email addresses,
phone numbers, postal addresses, work place details.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Contacts
properties:
- type: OpenAPI
url: openapi/aurinko-contacts-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-contact-schema.json
- type: JSONSchema
url: json-schema/aurinko-contact-or-id-schema.json
- aid: aurinko:aurinko-contsync-api
name: Yoxel Cont Sync API
description: Sync/delta methods.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- ContSync
properties:
- type: OpenAPI
url: openapi/aurinko-contsync-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-deleted-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-contacts-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-sync-status-schema.json
- aid: aurinko:aurinko-drafts-api
name: Yoxel Drafts API
description: A draft message is a message which has not been sent yet. The drafts endpoints let you create new drafts, read
existing drafts, and send drafts.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Drafts
properties:
- type: OpenAPI
url: openapi/aurinko-drafts-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-email-message-schema.json
- aid: aurinko:aurinko-emailfolders-api
name: Yoxel Email Folders API
description: List email folders, their attributes, and messages.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- EmailFolders
properties:
- type: OpenAPI
url: openapi/aurinko-emailfolders-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-email-message-schema.json
- aid: aurinko:aurinko-emailsync-api
name: Yoxel Email Sync API
description: Sync/delta methods.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- EmailSync
properties:
- type: OpenAPI
url: openapi/aurinko-emailsync-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-email-message-schema.json
- aid: aurinko:aurinko-emailtracking-api
name: Yoxel Email Tracking API
description: Track email opens.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Email Tracking
tags_raw:
- EmailTracking
properties:
- type: OpenAPI
url: openapi/aurinko-emailtracking-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-email-tracking-event-schema.json
- type: JSONSchema
url: json-schema/aurinko-tracking-data-schema.json
- type: JSONSchema
url: json-schema/aurinko-email-draft-create-tracking-response-schema.json
- type: JSONSchema
url: json-schema/aurinko-email-tracking-event-page-next-schema.json
- type: JSONSchema
url: json-schema/aurinko-email-tracking-page-next-schema.json
- type: JSONSchema
url: json-schema/aurinko-convert-draft-schema.json
- aid: aurinko:aurinko-events-api
name: Yoxel Events API
description: Events are objects within a calendar, generally supporting all features of modern scheduling apps. Using the
calendar APIs, your application can schedule events, send meeting invitations, RSVP, and more.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Event
tags_raw:
- Events
properties:
- type: OpenAPI
url: openapi/aurinko-events-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-event-schema.json
- type: JSONSchema
url: json-schema/aurinko-event-or-id-schema.json
- type: JSONSchema
url: json-schema/aurinko-series-info-schema.json
- type: JSONSchema
url: json-schema/aurinko-events-page-next-schema.json
- type: JSONSchema
url: json-schema/aurinko-meeting-response-schema.json
- type: JSONSchema
url: json-schema/aurinko-email-attachment-content-schema.json
- aid: aurinko:aurinko-followuprobot-api
name: Yoxel Follow Up Robot API
description: Follow-up rules allow you to define automatic email follow-up (drip) sequences and email templates. List, create,
update, and delete follow-up rules associated with a mailbox account. Check status of a drip sequence for a given email
thread, or activate a drip sequence.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- FollowUpRobot
properties:
- type: OpenAPI
url: openapi/aurinko-followuprobot-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-conversation-drip-status-schema.json
- type: JSONSchema
url: json-schema/aurinko-drip-request-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-followup-rule-aggregate-out-schema.json
- type: JSONSchema
url: json-schema/aurinko-followup-rule-aggregate-in-schema.json
- type: JSONSchema
url: json-schema/aurinko-followup-config-schema.json
- aid: aurinko:aurinko-freebusyschedule-api
name: Yoxel Free Busy Schedule API
description: Check free/busy status for a calendar or available time slots for a meeting in multiple calendars.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- FreeBusySchedule
properties:
- type: OpenAPI
url: openapi/aurinko-freebusyschedule-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-suggest-meeting-times-request-schema.json
- type: JSONSchema
url: json-schema/aurinko-free-busy-request-schema.json
- type: JSONSchema
url: json-schema/aurinko-suggest-meeting-times-response-schema.json
- type: JSONSchema
url: json-schema/aurinko-work-hours-response-schema.json
- type: JSONSchema
url: json-schema/aurinko-free-busy-schedule-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-work-hours-request-schema.json
- aid: aurinko:aurinko-groupbooking-api
name: Yoxel Group Booking API
description: Group Booking profiles allow you to build calendar availability and meeting scheduling for a group of accounts.
List, create, update, and delete booking profiles associated with a group. Gather availability information from multiple
account calendars and find time slots when at least one user is available. Schedule events for available accounts.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- GroupBooking
properties:
- type: OpenAPI
url: openapi/aurinko-groupbooking-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-group-booking-out-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-group-booking-in-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-group-booking-update-dto-schema.json
- aid: aurinko:aurinko-managed-accounts-api
name: Yoxel Managed accounts API
description: Manage accounts rely on service accounts for their connections. List, cancel, update, and delete managed accounts
associated with service accounts.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Managed Accounts
tags_raw:
- Managed accounts
properties:
- type: OpenAPI
url: openapi/aurinko-managed-accounts-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-api-account-in-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-account-save-result-schema.json
- aid: aurinko:aurinko-messages-api
name: Yoxel Messages API
description: Messages contain several pieces of information, such as when a message was sent, the sender's address, to whom
it was sent, and the message body. They can also contain files (attachments), calendar event invitations, and more.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Message
tags_raw:
- Messages
properties:
- type: OpenAPI
url: openapi/aurinko-messages-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-email-message-schema.json
- aid: aurinko:aurinko-services-api
name: Yoxel Services API
description: Service accounts represent admin/service/organization level connections. List, cancel, update, and delete service
accounts associated with your application.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Services
properties:
- type: OpenAPI
url: openapi/aurinko-services-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-api-account-in-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-accounts-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-account-save-result-schema.json
- aid: aurinko:aurinko-tasklists-api
name: Yoxel Task Lists API
description: TaskLists a container objects for tasks.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- TaskLists
properties:
- type: OpenAPI
url: openapi/aurinko-tasklists-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-task-list-schema.json
- type: JSONSchema
url: json-schema/aurinko-task-list-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-ok-response-schema.json
- type: JSONSchema
url: json-schema/aurinko-task-list-create-schema.json
- type: JSONSchema
url: json-schema/aurinko-task-list-update-schema.json
- aid: aurinko:aurinko-tasks-api
name: Yoxel Tasks API
description: Tasks a work to be done.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Task
tags_raw:
- Tasks
properties:
- type: OpenAPI
url: openapi/aurinko-tasks-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-task-schema.json
- type: JSONSchema
url: json-schema/aurinko-task-create-schema.json
- type: JSONSchema
url: json-schema/aurinko-task-update-schema.json
- type: JSONSchema
url: json-schema/aurinko-tasks-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-task-create-response-schema.json
- type: JSONSchema
url: json-schema/aurinko-task-update-response-schema.json
- aid: aurinko:aurinko-tasksync-api
name: Yoxel Task Sync API
description: Sync/delta methods.
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- TaskSync
properties:
- type: OpenAPI
url: openapi/aurinko-tasksync-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-deleted-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-sync-tasks-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-sync-status-schema.json
- aid: aurinko:aurinko-user-api
name: Yoxel User API
description: '`User` is an Aurinko managed entity that your app can leverage to implement user session management. Multiple
regular Aurinko accounts can be linked to a `User` however there is always one primary account that acts as the user id-provider.
The `User` sessions allow browser apps to store all their account access tokens securely on the Aurinko servers.'
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- User
properties:
- type: OpenAPI
url: openapi/aurinko-user-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-end-user-account-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-end-user-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-end-user-accounts-page-schema.json
- type: JSONSchema
url: json-schema/aurinko-end-user-settings-dto-schema.json
- type: JSONSchema
url: json-schema/aurinko-ok-response-schema.json
- aid: aurinko:aurinko-webhooks-api
name: Yoxel Webhooks API
description: "Webhooks allow your application to receive simple notifications when certain events occur.\nThey essentially\
\ tell your application that it can run incremental syncs to obtain the changed records (updated/deleted).\n\n## Prerequisites\n\
Gmail notifications require a special configuration, explained in [this article](https://developers.google.com/gmail/api/guides/push).\n\
A PubSub PUSH subscription should specify your Aurinko endpoint `https://{yourAurinkoDomain}/push/google/email`\nso that\
\ Gmail notifications are delivered to Aurinko first. Once the PubSub subscription is configured\nand the `publish` rights\
\ are granted to `gmail-api-push@system.gserviceaccount.com` please specify your\nPubSub topic in the Application settings\
\ (Google OAuth) in the Aurinko portal.\n\n## Notification URL verification\nTo ensure that notifications are being delivered\
\ to a server under your direct control, we must verify\nyour ownership by issuing you a challenge request. Please make\
\ sure your notification endpoint\n(specified in the notificationUrl property) responds to a validation request. If validation\
\ fails,\nthe request to create the subscription returns a 400 Bad Request error.\n\n1. Aurinko sends a POST request to\
\ the notification URL:\n ```\n Content-Type: text/plain; charset=utf-8\n POST https://{notificationUrl}?validationToken={challenge}\n\
\ ```\n2. The client must provide a response:\n * A 200 (OK) status code.\n * The body must include the validation\
\ token provided by the validationToken query parameter\n\n## Notifications\nAurinko sends notifications as POST requests\
\ with the following json payload:\n```\n{\n \"subscription\" : integer, // subscription Id\n \"resource\" : string,\n\
\ \"accountId\": integer,\n \"error\": string, // if any\n \"lifecycleEvent\": string, // Enum of `error`\
\ or `active`, when subscription state changes\n \"payloads\" : [...]\n}\n```\n\nYou notification endpoint should respond\
\ with the 200 (OK) status code when a notification is successfully processed.\n\n### Notification validation\nAurinko\
\ signs its requests using a secret unique to your app.\nHere's an overview of the process to validate a signed request\
\ from Aurinko:\n\n1. Retrieve the `X-Aurinko-Request-Timestamp` header on the HTTP request, and the body of the request\
\ (Use the raw request body, before it has been deserialized from JSON or other forms.).\n2. Concatenate the version number,\
\ the timestamp, and the body of the request to form a basestring. Use a colon as the delimiter between the three elements.\n\
The version number right now is always `v0`.\n```\nfinal byte[] signData = org.apache.commons.lang3.ArrayUtils.addAll(\n\
\ (\"v0:\" + timestampSeconds + \":\").getBytes(StandardCharsets.UTF_8),\n payloadBytes\n);\n```\n3. With the help\
\ of HMAC SHA256 implemented in your favorite programming language, hash the above basestring, using the Aurinko Signing\
\ Secret as the key.\n4. Compare this computed signature to the `X-Aurinko-Signature` header on the request.\nIf it matches\
\ - request is valid, if not - request must be discarded."
humanURL: https://apirefs.aurinko.io/
baseURL: https://api.aurinko.io
tags:
- Webhook
tags_raw:
- Webhooks
properties:
- type: OpenAPI
url: openapi/aurinko-webhooks-api-openapi.yml
- type: JSONSchema
url: json-schema/aurinko-subscription-response-schema.json
x-enrichment:
date: '2026-10-19'
status: enriched
artifacts_added: 26
pass: modular-v1
engine: identity=local,contract=local,surfaces=local,docs=local,regulatory=local
Yoxel API — frequently asked questions
Does Yoxel have an API?
Yes. APIs.io lists 25 APIs from Yoxel, including Yoxel Account API, Yoxel Accounts API and Yoxel Auth API, and 22 more.
Is there an OpenAPI specification for the Yoxel API?
Yes. APIs.io indexes 25 OpenAPI specifications for Yoxel, each linked for download from this page.
How do I authenticate with the Yoxel API?
Yoxel uses bearer-token authentication (1 scheme). The details are profiled on APIs.io as Yoxel Authentication.
How much does the Yoxel API cost?
Yoxel publishes its prices; its Unified API plan is $1/ account/ month as of 2026-10-19. APIs.io lists 6 pricing plans for Yoxel, with each plan's price, limits and inclusions under Pricing on this page.
Is the Yoxel API ready for AI agents?
Yoxel has a Kin Score of 54.6 out of 100 (strong) and an Agent Readiness score of 28.7 (agent-ready), scored by API Evangelist on 2026-11-13.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
Kin Score
How this is scored →
It updates itself when the score changes. Paste this where you link to your API docs: