Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Extole (BYOK) — connector documentation

  • MCP endpoint: https://byok-extole.connectorbay.com/mcp
  • REST API: POST https://byok-extole.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-extole.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Extole Extole managed access token, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-extole.connectorbay.com/health · Tool schemas: https://byok-extole.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-extole · agent@connectorbay.com

What Extole (BYOK) is for

Extole (BYOK) lets an AI assistant read your own Extole data through the Extole API with a key you supply (Extole managed access token). Read-only: 12 tools (list_campaign_summaries, get_campaign_summary, list_audiences, get_audience_stats, list_reports, get_report_info, list_report_types, list_reward_suppliers, list_webhooks, list_event_streams, list_promotion_links, list_jobs). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.extole.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Extole. Extole and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Extole referral campaigns are live right now?"
  • "Show the summary of Extole campaign abc123"
  • "Which audiences are defined in Extole?"
  • "How many members does Extole audience aud_1 have?"
  • "What Extole reports were generated recently?"
  • "How many rows does Extole report rep_1 have?"

What it does

  • list_campaign_summaries: List referral and marketing campaigns as short summaries: name, type, program label, state, publish and start and stop dates, tags and variants.
  • get_campaign_summary: Get the summary of one campaign by its ID: name, state, program label, dates, tags and theme.
  • list_audiences: List audiences with ID, name, tags and whether they are enabled.
  • get_audience_stats: Get the number of active members of one audience.
  • list_reports: List generated reports with name, report type, tags, completion date and available download formats.
  • get_report_info: Get the number of rows in one generated report.
  • list_report_types: List available report types with their IDs, names and descriptions.
  • list_reward_suppliers: List reward suppliers (gift card, coupon and cash reward sources) configured for the program.
  • list_webhooks: List webhooks with their type and enabled state.
  • list_event_streams: List event streams that deliver program events, with name, tags and created and updated times.
  • list_promotion_links: List promotion links (shareable program URLs) with code, label, program URL and promotion URL.
  • list_jobs: List scheduled jobs with name, enabled state and created and updated times.

BYOK key

You bring your own Extole Extole managed access token (https://docs.extole.com/api-reference/getting-started/authentication-overview). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.extole.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Notices

Create a client-scoped access token in My Extole under Security Center, and give it only read scopes. Calls return what the token's scopes allow.

Data sources

Live from the Extole API (api.extole.io) with a BYOK key; documentation: https://docs.extole.com/api-reference/getting-started/authentication-overview. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Extole. Extole and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Extole account.

Built for: Worldwide. Languages: English.