Integration

Returning.AI integration

Returning.AI runs loyalty and rewards programs for brokers' traders: coins, XP, tiers, leaderboards, referrals, mini games, match predictions and a rewards Store, inside a community. Create, look up, filter and update traders and their custom fields, add or set XP and coin balances (one trader or by CSV), read activity and gamification logs, manage leaderboards, match predictions, Store categories, products and redemption orders, and post messages or chart analyses in community channels as a member. Not exposed: API key management (it returns keys), the Workflow Builder and its MCP route, the deprecated field-history addresses and the Legacy routes. Authentication: a Community API key (Settings > Integration > API Keys) sent as a Bearer token; each tool says which key permission it needs.

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in Returning.AI.Built from the 95 Returning.AI tools below, on the connection you add once.

What you can do with Returning.AI

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Category, 5 operations

  • create_store_categoryCreate store categoryPOSTAdd one category to the Store in the community that owns your API key. Needs the Community API key permission store ("Store" in the dashboard).
  • delete_store_categoryDelete store categoryDELETERemove one Store category from the community that owns your API key, leaving its products in place without a category. Needs the Community API key permission store ("Store" in the dashboard).
  • get_store_categoryGet store categoryGETRead one Store category in your community by its ID, with its access rules, starting order status and layout settings. Needs the Community API key permission store ("Store" in the dashboard).
  • list_store_categoriesList store categoriesGETList the Store categories in the community that owns your API key, one page at a time. Needs the Community API key permission store ("Store" in the dashboard).
  • update_store_categoryUpdate store categoryPUTChange one Store category in your community, updating only the fields you send. Needs the Community API key permission store ("Store" in the dashboard).

Leaderboard, 5 operations

  • create_leaderboardCreate leaderboardPOSTCreate one leaderboard in the community that owns your API key, with its ranking metric, schedule, audience and prizes. Needs the Community API key permission leaderboard ("Leaderboard" in the dashboard).
  • delete_leaderboardDelete leaderboardDELETEPermanently delete one leaderboard in the community that owns your API key. Needs the Community API key permission leaderboard ("Leaderboard" in the dashboard).
  • get_leaderboardGet leaderboardGETRead one leaderboard in the community that owns your API key, with its schedule, audience, prizes and display settings. Needs the Community API key permission leaderboard ("Leaderboard" in the dashboard).
  • list_leaderboardsList leaderboardsGETList the leaderboards in the community that owns your API key, one page at a time. Needs the Community API key permission leaderboard ("Leaderboard" in the dashboard).
  • update_leaderboardUpdate leaderboardPATCHChange the settings of one leaderboard in the community that owns your API key, sending only the fields you want to change. Needs the Community API key permission leaderboard ("Leaderboard" in the dashboard).

Product, 5 operations

  • create_productCreate productPOSTCreates one Store product and loads its voucher codes as stock; unless isArchived is true, it is live in the Store at once. Needs the Community API key permission store.
  • delete_productDelete productDELETEPermanently remove one Store product from the community that owns your API key. Needs the Community API key permission store ("Store" in the dashboard).
  • get_productGet productGETRead one Store product in your community by its ID, with price, category, access rules and current stock. Needs the Community API key permission store ("Store" in the dashboard).
  • list_productsList productsGETList the Store products in the community that owns your API key, one page at a time, with price, category and stock. Needs the Community API key permission store ("Store" in the dashboard).
  • replace_productReplace productPUTReplaces one Store product's settings with a full body and adds new voucher codes as stock. Read get_product first and send every field back with your change; send vouchers [] to add none. Needs the key permission store.

Status, 5 operations

  • create_redemption_statusCreate redemption statusPOSTAdd a status to your community's redemption order workflow, in one of the four fixed categories. Needs the Community API key permission createRedemptionStatus ("Create Redemption Status" in the dashboard).
  • get_bulk_update_statusGet bulk update statusGETCheck whether a bulk update job is queued, running or finished, with row counts once it completes. Needs the Community API key permission getBulkUpdate ("Get Bulk Update History" in the dashboard).
  • get_event_ingest_statusGet event ingest statusGETCheck whether a batch of events you sent to a data workflow has been received, run, skipped or failed. Needs the Community API key permission dataWorkflows ("Data Workflows" in the dashboard).
  • list_redemption_statusesList redemption statusesPOSTList every active redemption order status in your community, grouped by category, with the IDs you send as `statusID` when you update an order. Needs the Community API key permission getRedemptionStatuses ("Get Redemption Statuses" in the dashboard).
  • update_redemption_order_statusUpdate redemption order statusPUTMove one redemption order to another status, and optionally return the trader's coins when the new status is a refund. Needs the Community API key permission updateRedemptionTransactionStatus ("Update Redemption Transaction Status" in the dashboard).

User field, 5 operations

  • create_user_fieldCreate user fieldPOSTAdd a custom user field to your community, such as a KYC status, and get back the key you use to write traders' values. Needs the Community API key permission userFields ("User Fields" in the dashboard).
  • delete_user_fieldDelete user fieldDELETERemove one of your custom user fields by its key or ID, so it no longer appears in your field list and can't be written. Needs the Community API key permission userFields ("User Fields" in the dashboard).
  • get_user_fieldGet user fieldGETRead one user field's definition by its key or ID, to check its name, type and default before you write values. Needs the Community API key permission userFields ("User Fields" in the dashboard).
  • list_user_fieldsList user fieldsGETList every user field in your community, built-in and custom, with the key, type and default you need before you write values. Needs the Community API key permission userFields ("User Fields" in the dashboard).
  • update_user_fieldUpdate user fieldPUTRename one of your custom user fields, change its type, or set or clear its default, keeping the same key. Needs the Community API key permission userFields ("User Fields" in the dashboard).

Match prediction, 4 operations

  • create_match_predictionCreate match predictionPOSTCreate a match prediction as a draft in the community that owns your API key, ready to edit and then publish. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).
  • get_match_predictionGet match predictionGETRead one match prediction by ID, with its current status and version and, once settled, its settlement totals. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).
  • list_match_predictionsList match predictionsGETList the match predictions in your community, filtered by status, fixture ID or text, one page at a time. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).
  • update_match_predictionUpdate match predictionPATCHChange fields on one match prediction, guarded by its version so you never overwrite someone else's change. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).

Analysis, 3 operations

  • delete_chart_analysisDelete chart analysisDELETEDelete one chart analysis for good and hide the channel post that shows it. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).
  • get_chart_analysisGet chart analysisGETRead one chart analysis by its ID, with its levels, drawings, status and the channel post that shows it. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).
  • update_chart_analysisUpdate chart analysisPATCHChange a pending chart analysis's title, scenarios, expiry, timeframe, direction with new levels, or its drawings. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).

Bulk update, 3 operations

  • bulk_update_match_predictionsBulk update match predictionsPOSTChange up to 100 match predictions in one request, as a background job that applies each change like Patch match prediction. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).
  • bulk_update_usersBulk update usersPOSTUpload a CSV that changes many traders' profiles, roles, balances or custom fields in one background job. Needs the Community API key permission bulkUpdateUser ("Bulk Update User" in the dashboard).
  • list_bulk_update_jobsList bulk update jobsGETList your community's bulk user update jobs, newest first, so you can find a job's ID by its `log_name`. Needs the Community API key permission getBulkUpdate ("Get Bulk Update History" in the dashboard).

Channel, 3 operations

  • create_chart_analysisCreate chart analysisPOSTPost a chart analysis card, with direction, price levels and optional drawings, into a chart-enabled channel on behalf of a member. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).
  • list_channelsList channelsGETList the chat channels in the community that owns your API key, with each channel's ID, name and type. Any Community API key for this community works.
  • list_chart_analysesList chart analysesGETList the chart analyses in one channel, newest first, with optional filters for status, direction and timeframe. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).

History, 3 operations

  • list_field_historyList field historyGETList every recorded change to one user field across all your traders, newest first, a page at a time. Needs the Community API key permission userFields ("User Fields" in the dashboard).
  • list_user_field_value_historyList user field value historyGETList every recorded change to one trader's value for one user field, newest first, a page at a time. Needs the Community API key permission userFields ("User Fields" in the dashboard).
  • update_user_field_valueUpdate user field valuePOSTSet, increase or decrease one trader's value for one user field, and record the change in that field's history. Needs the Community API key permission userFields ("User Fields" in the dashboard).

User, 3 operations

  • create_userCreate userPOSTRegister one trader in the community that owns your API key, and store their broker customer ID in the same call. Needs the Community API key permission createUser ("Create User" in the dashboard).
  • get_community_memberGet community memberGETGet one trader's name, username, email, avatar, online status and last sign-in, by their internal record ID or email. Any Community API key for this community works.
  • list_community_membersList community membersGETGet one page of your community's traders, with their names, email, online status and last sign-in. Any Community API key for this community works.

Bulk, 2 operations

  • create_products_in_bulkCreate products in bulkPOSTCreates up to 100 Store products, each with its voucher codes, in one all-or-nothing call; every product not marked isArchived is live in the Store at once. Needs the Community API key permission store.
  • update_products_in_bulkUpdate products in bulkPUTChanges up to 100 Store products in one all-or-nothing call, sending only the fields that change for each; new voucher codes are added as stock. Needs the Community API key permission store.

By email, 2 operations

  • list_mini_game_logsList mini game logsPOSTList one trader's spin-the-wheel history in your community, newest first, one page at a time. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).
  • list_redemption_orders_by_emailList redemption orders by emailPOSTList one trader's redemption orders in your community, newest first, finding the trader by their email. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Detail, 2 operations

  • get_bulk_update_detailsGet bulk update detailsGETRead the row-by-row result of a finished bulk update job, including which rows failed and why. Needs the Community API key permission getBulkUpdate ("Get Bulk Update History" in the dashboard).
  • get_redemption_statusGet redemption statusPOSTRead one active redemption order status in your community by its ID, with its name, category and colour. Needs the Community API key permission getRedemptionStatusById ("Get Redemption Status By ID" in the dashboard).

Loyalty export, 2 operations

  • create_loyalty_points_exportCreate loyalty points exportPOSTRequest a CSV or JSON file of recorded reward-coin history for a date range. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).
  • get_loyalty_export_statusGet loyalty export statusGETCheck whether an export has completed and read its row count and file size. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Result, 2 operations

  • list_match_prediction_bulk_job_resultsList match prediction bulk job resultsGETRead each item's result from a match prediction bulk update job, one page at a time, once the job has finished. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).
  • list_match_prediction_resultsList match prediction resultsGETRead the outcome of a settlement or void: the totals and each trader's prediction and payout or refund, one page at a time. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).

Store, 2 operations

  • get_store_configurationGet store configurationGETRead the Store settings for the community that owns your API key, including its title, banner, coin display and embeddable widget. Needs the Community API key permission store ("Store" in the dashboard).
  • replace_store_configurationReplace store configurationPUTReplaces the Store settings (title, description, banner, coin display, widget) with a full body. Read get_store_configuration first and send every field back with your change. Needs the key permission store.

User field history, 2 operations

  • list_community_field_historyList community field historyGETList every recorded change to any trader's user field values in your community, newest first, a page at a time. Needs the Community API key permission userFields ("User Fields" in the dashboard).
  • list_user_field_historyList user field historyGETList every recorded change to one trader's user field values, XP and coins, newest first, a page at a time. Needs the Community API key permission userFields ("User Fields" in the dashboard).

Appearance, 1 operation

  • update_community_appearanceUpdate community appearancePUTChange your community's theme, logos, loading animation or call-to-action button, sending only the parts you want to change. Needs the Community API key permission appearance ("Appearance" in the dashboard).

Bulk job, 1 operation

  • get_match_prediction_bulk_jobGet match prediction bulk jobGETCheck whether a match prediction bulk update job is queued, running or finished, with its item counts. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).

Bulk update premium currency, 1 operation

  • bulk_update_premium_currencyBulk update premium currencyPOSTUpload a CSV that adds to, subtracts from or sets many traders' premium currency balances in one background job. Needs the Community API key permission bulkUpdatePremiumCurrency (or bulkUpdateUser).

By community, 1 operation

  • list_redemption_ordersList redemption ordersPOSTList every redemption order in your community, newest first, one page at a time. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

By identifier, 1 operation

  • list_redemption_orders_by_identifierList redemption orders by identifierPOSTList one trader's redemption orders in your community, newest first, finding the trader by a custom user field such as your broker customer ID. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Community bot, 1 operation

  • update_community_bot_profileUpdate community bot profilePUTChange the name and avatar that your community's bot shows next to its messages. Needs the Community API key permission appearance ("Appearance" in the dashboard).

Community log, 1 operation

  • get_community_logsGet community logsGETRead your community's gamification, milestone, API or mini-game logs for a date range, as JSON pages or as a CSV file to download. Needs the Community API key permission readCommunityLogs ("Get Community Logs" in the dashboard).

Daily, 1 operation

  • get_daily_xp_and_coin_changesGet daily xp and coin changesPOSTGet the net XP and coin change for up to 100 traders on one UTC day. Needs the Community API key permission getUserStats ("Get User Stats" in the dashboard).

Download, 1 operation

  • get_loyalty_export_download_linkGet loyalty export download linkGETGet a temporary download URL for a completed export. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Drawing, 1 operation

  • add_chart_analysis_drawingsAdd chart analysis drawingsPOSTAdd drawings to a pending chart analysis, keeping the card and the drawings already on it. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).

Filter, 1 operation

  • filter_usersFilter usersPOSTSearch the traders in your community by profile, join date, balance, role or custom field, and get back only the fields you ask for, 200 at a time. Needs the Community API key permission getUserData ("Get User Data" in the dashboard).

Info, 1 operation

  • get_user_dataGet user dataPOSTLook up one trader in your community by email, platform user ID or broker identifier: profile, roles, balances, tier, activity counts and the custom fields you ask for. Needs the Community API key permission getUserData.

Log, 1 operation

  • search_gamification_logsSearch gamification logsPOSTList one trader's XP and coin changes in your community, newest first, with optional date, time and action filters. Needs the Community API key permission getUserStats ("Get User Stats" in the dashboard).

Loyalty overview, 1 operation

  • list_loyalty_overviewList loyalty overviewGETPage through one loyalty summary row per trader in your community, with balances, roles, visits and join date. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Manage, 1 operation

  • manage_user_accountManage user accountPOSTRemove one trader's account, or restore a removed account, by username or email. Needs the Community API key permission manageUser ("Delete/Restore User" in the dashboard).

Message, 1 operation

  • list_messagesList messagesGETGet the newest messages in your community, optionally from one channel or one trader, as plain text with the sender and channel. Needs the Community API key permission getMessages ("Get Messages" in the dashboard).

Milestone, 1 operation

  • get_user_milestonesGet user milestonesPOSTCheck which of the milestones you name a trader has cleared, stage by stage, using their email. Needs the Community API key permission getUserData ("Get User Data" in the dashboard).

Mini game streak stats, 1 operation

  • get_mini_game_streak_stateGet mini game streak statePOSTRead one trader's spin-wheel and streak state right now, by email. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Phone verification contact, 1 operation

  • list_phone_verification_contactsList phone verification contactsGETPage through the phone numbers your traders verified by SMS in your community, each with the trader's email. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Program, 1 operation

  • list_referral_programsList referral programsGETList the referral programs set up in the community that owns your API key, with each stage's requirements and rewards. Needs the Community API key permission getUserData ("Get User Data" in the dashboard).

Publish, 1 operation

  • publish_match_predictionPublish match predictionPOSTPublish a draft match prediction so the traders it targets can see it and, from `predictionStartAt`, submit predictions. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).

Purchase history, 1 operation

  • update_redemption_order_detailsUpdate redemption order detailsPATCHChange the redemption instructions, voucher code or customer details saved on one redemption order in your community. Needs the Community API key permission purchase-history ("Purchase History" in the dashboard).

React, 1 operation

  • react_to_messageReact to messagePOSTAdd an emoji reaction to one message in your community, as an existing member. Needs the Community API key permission replyMessage ("Reply Message" in the dashboard).

Redemption transaction, 1 operation

  • get_redemption_orderGet redemption orderGETRead one redemption order in your community by its order ID, with its status, the trader's details and their order-form answers. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Reply, 1 operation

  • reply_to_messageReply to messagePOSTPost a reply to one message as an existing member, in the same channel, forum topic or direct conversation. Needs the Community API key permission replyMessage ("Reply Message" in the dashboard).

Send, 1 operation

  • send_messageSend messagePOSTPost a message to one of your community's channels as an existing member, with text, image links or both. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).

Settlement, 1 operation

  • settle_match_predictionSettle match predictionPOSTSend a match's final score to start paying rewards to the traders who predicted it correctly. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).

Stats, 1 operation

  • get_user_activity_statsGet user activity statsPOSTCount one trader's messages, replies, reactions and social actions per day over the last 1 to 90 days. Needs the Community API key permission getUserStats ("Get User Stats" in the dashboard).

Streak log, 1 operation

  • list_streak_logsList streak logsGETList streak history entries for one trader or your whole community, newest first, one page at a time. Needs the Community API key permission getStreakLogs ("Get Streak Logs" in the dashboard).

Summary, 1 operation

  • get_referral_summaryGet referral summaryPOSTRead one trader's referral invite link, their referral totals and each invited trader's progress through your programs. Needs the Community API key permission getUserData ("Get User Data" in the dashboard).

Tiers info, 1 operation

  • get_tier_configurationGet tier configurationGETRead your community's tiers and the XP each level in them needs. Needs the Community API key permission getTiersInfo ("Get Tier Infos" in the dashboard).

Transaction history, 1 operation

  • get_redemption_order_historyGet redemption order historyPOSTRead every status change on one redemption order, oldest first, with who or what made each change. Needs the Community API key permission getRedemptionTransactionHistory ("Get Redemption Transaction History" in the dashboard).

Update, 1 operation

  • update_userUpdate userPOSTChange one trader's profile, community roles or broker identifier, sending only the fields that change. Needs the Community API key permission manageUser (Role changes also need bulkUpdateUser).

Update wheel info, 1 operation

  • update_spin_wheel_infoUpdate spin wheel infoPOSTAdd, remove or set one trader's available spins, wheel streak or both on one spin-the-wheel game. Needs the Community API key permission customerSuccess ("Customer Success" in the dashboard).

Update xp currency, 1 operation

  • update_user_xp_and_currencyUpdate user xp and currencyPOSTAdd to, subtract from or set one trader's XP, coin balance or both, and get back the new balances. Needs the Community API key permission manageUser ("Delete/Restore User" in the dashboard).

Upload image, 1 operation

  • upload_message_imagesUpload message imagesPOSTUpload up to 10 image files and get a public URL for each, ready to attach to a message. Needs the Community API key permission sendMessage ("Send Messages" in the dashboard).

Void, 1 operation

  • void_match_predictionVoid match predictionPOSTCancel a published match prediction and refund every trader's entry cost, without paying any rewards. Needs the Community API key permission matchPredictions ("Match Prediction" in the dashboard).

Use Returning.AI from Claude Code, Cursor or Codex

Connect Returning.AI in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Returning.AI operations become tools the client can call, next to every other integration you connected.

Claude Code
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"
Codex (~/.codex/config.toml)
[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"
Cursor, Claude Desktop and other JSON configs
{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect Returning.AI

  1. Create your workspace

    Sign up free. Nothing to install.

  2. Connect Returning.AI once

    Add your Returning.AI connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.

  3. Describe the job in chat

    The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.

Returning.AI integration FAQ

What can you do with the Returning.AI integration?

LiveContext exposes 95 operations on Returning.AI, covering category, leaderboard, product and status.

Popular integrations

Browse the whole catalog