Aghanim Documentation
website·Indexed 33 days ago
https://docs.aghanim.comA platform for integrating mobile games with a web hub, featuring tools for player authorization, achievements, leaderboards, and in-game popups. Includes Aghanim Connect for integrations with analytics and authentication providers such as Google, Apple, Discord, Facebook, PlayFab, and Meta Pixel.
What's inside Aghanim
- The Aghanim LiveOps Campaign Builder provides tools for game developers to create and manage marketing strategies, such as special offers, discounts, and player retention promotions. Campaigns are managed via the Aghanim Dashboard under the LiveOps Builder section.
Overview of Sandbox to Production migration
Sandbox and Production are entirely separate environments with different internal IDs, content, webhooks, and keys. Migration is a manual process where you build the hub in Sandbox and then move the configuration to Production. The migration tools re-link entities using user-controlled keys (SKU, store key, page/article slug, price template key, and reward key) rather than internal IDs, which change between environments.Overview of Webhook Batch Export
Webhook Batch Export allows Aghanim to collect events over a time window and store them as a JSONL file instead of sending individual webhook requests for every event. Once the batch is ready, Aghanim sends a singlebatch.readynotification containing a pre-signed URL to download the batch file. The download URL expires after 24 hours.Overview of Newton MCP
The Newton MCP server allows MCP-aware AI coding tools to access Aghanim's product documentation and OpenAPI specs. This enables agents to search documentation, fetch pages, browse API groups, and inspect request/response schemas within the editor. The server uses streamable HTTP transport and OAuth 2.0 / Auth0 for authentication.Endpoint:https://mcp.aghanim.com/mcp/Overview of Aghanim Checkout payment flows
Aghanim Checkout is a web-based payment flow supporting over 80 payment methods globally. It allows developers to accept payments for in-game items. Depending on the integration method and platform policies (Apple App Store and Google Play Store), developers can implement the payment form using three primary interaction flows: Default browser, In-app browser, or Native UI. Generally, more native implementations result in higher conversion rates.Overview of Aghanim Checkout Links
Checkout Links provide a lightweight, portal-based integration for accepting online payments for game items via a prebuilt checkout page. This method is ideal when a full API or SDK implementation is excessive. It requires a registered Aghanim account and a game published on the Apple App Store or Google Play Store.Overview of Aghanim Skills
Aghanim Skills are installable playbooks for AI coding agents. They provide step-by-step guidance for specific Aghanim workflows, such as project inspection, gap filling, idiomatic code generation, and test execution. Skills rely on live Aghanim documentation and schemas fetched via the Newton MCP server usingmcp__aghanim__*tools.Overview of Aghanim Connect analytics connectors
Aghanim Connect provides ready-made connectors for marketing attribution and product analytics. Integration requires a one-time setup in the Dashboard: navigate to Dashboard → Aghanim Connect → [connector] → Install and provide the API key from your provider.
There are two types of connectors:
- Server-to-server: Aghanim's backend sends monetization events (purchase, refund) directly to the provider's API. These are immune to ad blockers.
- Web pixels (client-side): The hub loads the provider's script to report on-site behavior such as page views, item views, add-to-cart, and checkout starts.
Overview of Composite Authorization in Aghanim
Composite Authorization allows players to be uniquely identified by multiple fields rather than a single ID. This enables the Game Hub to present a custom login form prompting players for multiple identifiers (e.g.,account_id,server_id, andcharacter_id). To use this, you must configure the 'Composite User ID' login type in Game → Settings within the Aghanim dashboard.Overview of the Facebook News Plugin
The Facebook News plugin automatically imports posts from a selected Facebook account and converts them into news articles within an Aghanim game hub. It monitors the account for new posts and syncs text, images, and metadata in near real-time, ensuring the community is updated without manual intervention.Overview of the Payment Dispute Evidence process
When a player disputes a payment, the payment processor requires proof that the purchase was legitimate and delivered. Aghanim manages the evidence package, but game servers must provide game-side facts (consumption status, usage location, and player account details) via the S2S Dispute Evidence API.
The workflow is as follows:
- Dispute opened: Aghanim sends a
payment.disputewebhook. - Evidence submission: The game server calls the Dispute Evidence API with consumption facts and player details.
- Package submission: Aghanim includes the provided evidence in the package sent to the payment processor.
- Resolution: The outcome is delivered via
payment.succeeded(won) orpayment.chargeback(lost) webhooks.
- Dispute opened: Aghanim sends a
Overview of Aghanim AI coding tool integrations
Aghanim provides integrations for AI coding agents to search documentation, browse public APIs, and scaffold integrations. These are available in three layers:
- Editor Plugins: Bundled packages (MCP server, skills, slash commands) for one-line installation (e.g., Claude Code plugin).
- Newton MCP Server: The core source of truth that powers plugins and can be configured manually for any MCP-aware agent.
- Skills: Stack-agnostic playbooks (like
/aghanim-webhooks-quick-start) that can be dropped into any agent's prompt to guide the implementation of webhook handlers.