# Extole Documentation: Technical Docs

> Guides, product documentation, and API reference for the Extole platform.

## Technical Docs

### Integration Overview

- [Integrating with Extole](https://docs.extole.com/technical/integration-overview/integrating-with-extole.md): Get an introduction to our various integration methods for both web and mobile.
- [Key Concepts](https://docs.extole.com/technical/integration-overview/key-concepts.md): Understand Extole from the bottom up by reading about our platform's core elements.
- [Set Person Profile Data from an Event](https://docs.extole.com/technical/integration-overview/set-person-profile-data-from-an-event.md): Prefix an event data key with me.public. or me.private. and Extole writes the value onto the person's profile, where campaign rules, audiences, and reports read it.

### Extole AI Tools

- [Extole AI Tools](https://docs.extole.com/technical/extole-ai-tools/index.md)

#### Extole MCP Server

- [Extole MCP Server](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/index.md): Connect your AI tools to Extole and manage your referral programs with your favorite AI
- [MCP Authentication](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/mcp-authentication.md): Choose between OAuth and access token authentication for Extole MCP clients.
- [Claude Desktop](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-claude.md): Connect Claude Desktop to Extole and manage your referral programs with natural language.
- [Claude Code](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-claude-code.md): Connect Claude Code to Extole and manage your referral programs from the terminal.
- [ChatGPT](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-chatgpt.md): Connect ChatGPT to Extole and manage your referral programs with natural language.
- [Cursor](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-cursor.md): Connect Cursor to Extole and manage your referral programs alongside your code.
- [Codex](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-codex.md): Connect OpenAI Codex CLI to Extole and invoke Extole tools in automated workflows.
- [Microsoft Copilot](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-copilot-studio.md): Connect Extole to Microsoft 365 Copilot Chat or Copilot Studio
- [Glean](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-glean.md): Connect the Extole MCP server to Glean so Glean Assistant and Glean Agents can manage referral programs using natural language.
- [Gemini Enterprise](https://docs.extole.com/technical/extole-ai-tools/extole-mcp-server/setup-gemini.md): Connect Gemini Enterprise to Extole and manage your referral programs with natural language.

#### Extole CLI

- [Extole CLI](https://docs.extole.com/technical/extole-ai-tools/extole-cli/index.md): A command-line tool for interacting from the terminal and integrating into scripts and AI tools.
- [Claude Desktop](https://docs.extole.com/technical/extole-ai-tools/extole-cli/extole-cli-claude-desktop.md): Configure Claude Desktop to use the Extole CLI as an MCP tool source in one command.
- [Claude Code](https://docs.extole.com/technical/extole-ai-tools/extole-cli/extole-cli-claude-code.md): Configure Claude Code to use the Extole CLI as an MCP tool source in one command.

### Platform Integrations

- [Data Analysis & Visualization](https://docs.extole.com/technical/platform-integrations/data-analysis-visualization.md): Analyze Extole data in your data visualization tool.

#### JavaScript SDK

- [JavaScript SDK](https://docs.extole.com/technical/platform-integrations/javascript-sdk/index.md): Extole's JavaScript SDK is integrated into your online experience by placing simple JavaScript tags on web pages to allow program optimization without additional development.
- [Advanced Concepts](https://docs.extole.com/technical/platform-integrations/javascript-sdk/advanced-concepts.md): Our JavaScript SDK supports a wide variety of custom use cases and can be tailored to fit the needs and goals of your company. Read about some of our more common advanced tagging scenarios.
- [FAQs](https://docs.extole.com/technical/platform-integrations/javascript-sdk/faqs.md): Reference our answers to frequently asked questions about our JavaScript SDK and tagging your website.

#### Mobile SDKs

- [Mobile SDKs](https://docs.extole.com/technical/platform-integrations/mobile-sdks/index.md): Extole offers lightweight mobile SDKs for iOS, Android, and React Native.
- [Android SDK](https://docs.extole.com/technical/platform-integrations/mobile-sdks/android-sdk.md): This integration guide shows you how to set up and launch an Extole program as quickly as possible with our Android SDK.
- [iOS SDK](https://docs.extole.com/technical/platform-integrations/mobile-sdks/ios-sdk.md): This integration guide shows you how to set up and launch an Extole program as quickly as possible with our iOS SDK.
- [React Native SDK](https://docs.extole.com/technical/platform-integrations/mobile-sdks/react-native-sdk.md): This integration guide shows you how to set up and launch an Extole program as quickly as possible with our React Native SDK.
- [Deep Link Integrations](https://docs.extole.com/technical/platform-integrations/mobile-sdks/deep-link-integrations.md): Extole can integrate with your deeplink provider to power your experiences on all devices.

#### REST APIs

- [REST APIs](https://docs.extole.com/technical/platform-integrations/rest-apis/index.md): Extole has three REST-style APIs. Server to Extole, Consumer to Extole, and Management
- [Headless and Mobile API](https://docs.extole.com/technical/platform-integrations/rest-apis/mobile-api.md): Create a typical in-app share experience using Extole's Admin API with mobile phone built-in sharing capabilities.
- [Errors](https://docs.extole.com/technical/platform-integrations/rest-apis/errors.md): Brush up on common errors returned by our APIs.
- [API References](https://docs.extole.com/technical/platform-integrations/rest-apis/api-references.md)
- [Asynchronous Reporting API](https://docs.extole.com/technical/platform-integrations/rest-apis/asynchronous-reporting-api.md)

#### Files

- [Files](https://docs.extole.com/technical/platform-integrations/files/index.md): Extole offers several ways for you to send and receive important program data through file transfers.
- [Extole SFTP Server](https://docs.extole.com/technical/platform-integrations/files/extoles-sftp-server.md): Set up and use internal servers within your My Extole account.
- [External SFTP Servers](https://docs.extole.com/technical/platform-integrations/files/external-sftp-servers.md): Set up external servers in your My Extole account and send data from your programs into other systems.
- [General File Uploads](https://docs.extole.com/technical/platform-integrations/files/general-file-uploads.md): Upload files directly into your My Extole account using our Batch Jobs page.
- [File-based Events](https://docs.extole.com/technical/platform-integrations/files/file-based-events.md): Understand when to send event files to Extole, our file naming conventions, and more.
- [Audience Files](https://docs.extole.com/technical/platform-integrations/files/audience-files.md): Extole offers the ability to modify audiences via file uploads automatically.
- [Troubleshooting Audience File Processing](https://docs.extole.com/technical/platform-integrations/files/troubleshooting-audience-file-processing.md): Find and interpret errors from audience add, replace, and remove file processing, and resolve the most common failures yourself.

#### Webhooks

- [Webhooks](https://docs.extole.com/technical/platform-integrations/webhooks/index.md): Webhooks can be seen as the key building blocks of applications, allowing systems to exchange data in real-time in response to events. They act as the modern, web-oriented way for servers to receive notifications from other servers. Now, wh…
- [Webhook Creation](https://docs.extole.com/technical/platform-integrations/webhooks/webhook-creation.md): Customize the format and authentication method of your webhooks as needed.
- [Reward Webhooks](https://docs.extole.com/technical/platform-integrations/webhooks/reward-webhooks.md): Learn more about the most frequent use case for Extole outbound webhooks.

#### Extensions

- [Extensions](https://docs.extole.com/technical/platform-integrations/extensions/index.md): Extole offers Extensions to enhance your marketing campaigns to meet your specific business needs.
- [File Integration — Beta](https://docs.extole.com/technical/platform-integrations/extensions/file-integration.md): Install the File Integration extension so files delivered to your Extole directory become jobs that validate headers and create one event per row.
- [Create Share Link on an Event](https://docs.extole.com/technical/platform-integrations/extensions/create-share-link-on-an-event.md): Make sharing as easy as possible by precreating share links for every customer using the Extole extension or API

##### Reward Bank

- [Reward Bank](https://docs.extole.com/technical/platform-integrations/extensions/reward-bank.md): Reward Bank is an extension that allows consumers to accumulate and combine rewards for greater value while efficiently managing your incentives budget
- [Reward Bank Configuration Guide](https://docs.extole.com/technical/platform-integrations/extensions/reward-bank/reward-bank-configuration-guide.md): By following this guide, you can effectively configure and manage the Reward Bank feature, providing users with a flexible and engaging rewards experience. For an overview of the Reward Bank and its key components, see the [Reward Bank Overview](./reward-bank).

##### Event Streams Overview

- [Event Streams Overview](https://docs.extole.com/technical/platform-integrations/extensions/event-streams-overview.md): This guide explains how to configure and use Event Streams in the Extole platform.
- [Event Stream Query Language](https://docs.extole.com/technical/platform-integrations/extensions/event-streams-overview/event-stream-query-language.md)

### Partners

#### Account Opening

- [Clutch](https://docs.extole.com/technical/partners/account-opening/withclutch.md)
- [MANTL](https://docs.extole.com/technical/partners/account-opening/mantl.md)

#### Appointment Management

- [Boulevard (BLVD)](https://docs.extole.com/technical/partners/appointment-management/boulevard-blvd.md): Boulevard is the first and only client experience platform for appointment-based, self-care businesses.

#### Automations

- [Zapier](https://docs.extole.com/technical/partners/automations/zapier.md): Zapier is an automation platform that connects thousands of apps, enabling users to automate workflows without writing code.

#### Core Banking

- [Fiserv DNA](https://docs.extole.com/technical/partners/core-banking/fiserv-dna.md)

#### Customer Data

- [Amplitude](https://docs.extole.com/technical/partners/customer-data/amplitude.md): Send data from Amplitude to Extole to take action on your customer data to drive growth and deliver better customer experiences.
- [Segment](https://docs.extole.com/technical/partners/customer-data/segment.md): Send data from Segment to Extole to target your advocation and engagement programs to specific groups of customers.

#### CRM

- [Extole to Salesforce CRM](https://docs.extole.com/technical/partners/crm/extole-to-salesforce-crm.md): Learn how to send Extole real-time referrals, rewards, and customer engagement data to Salesforce through outbound webhooks.
- [HubSpot](https://docs.extole.com/technical/partners/crm/hubspot.md): Sync advocate share links into HubSpot contact records, and send HubSpot form completions and deal outcomes to Extole for referral tracking and reward scoring.
- [Salesforce CRM to Extole (Apex and Flows)](https://docs.extole.com/technical/partners/crm/salesforce-sales-cloud-apex-and-flows.md): Send event data from Salesforce CRM (Salesforce Sales Cloud) to Extole using Apex triggers and automate your processes using Flows.
- [ServiceTitan](https://docs.extole.com/technical/partners/crm/service-titan.md): Integrate Extole with ServiceTitan to automatically reward prospects and customers for referrals and other key actions.

#### Digital Banking

- [Alkami](https://docs.extole.com/technical/partners/digital-banking/alkami.md): The Extole and Alkami integration turns your digital banking channel into a valuable source of new members through personalized referral and engagement programs.
- [Banno (Jack Henry)](https://docs.extole.com/technical/partners/digital-banking/banno-jack-henry.md): Add an automated referral program to your Banno online, iOS, and Android applications with the Extole and Banno integration
- [Candescent (NCR Digital Insight)](https://docs.extole.com/technical/partners/digital-banking/ncr.md): Work with Candescent to set up secure in-portal access to your Extole programs

##### Q2

- [Q2](https://docs.extole.com/technical/partners/digital-banking/q2/index.md): Q2 offers digital banking solutions to grow with your business, your account holders, and the communities you serve.
- [Extole + Q2: Refer a Friend Marketing Kit](https://docs.extole.com/technical/partners/digital-banking/q2/q2-marketing-guide.md): Launch your referral program with a bang with this step-by-step marketing guide.

#### eCommerce

- [BigCommerce](https://docs.extole.com/technical/partners/ecommerce/bigcommerce.md): Place CTAs for your Extole programs in your BigCommerce storefront, track customer activity, and reward engagement with BigCommerce discounts.
- [Salesforce Commerce Cloud (SFRA)](https://docs.extole.com/technical/partners/ecommerce/salesforce-commerce-cloud-sfra.md): Implement Extole's cartridge into your Salesforce Commerce Cloud site.
- [Salesforce Commerce Cloud (Site Genesis)](https://docs.extole.com/technical/partners/ecommerce/salesforce-commerce-cloud-site-genesis.md): Implement Extole's cartridge into your Salesforce Commerce Cloud site.
- [Shopify Hydrogen](https://docs.extole.com/technical/partners/ecommerce/shopify-hydrogen.md): Hydrogen is Shopify’s official development framework for building headless storefronts.
- [Shopify Plus](https://docs.extole.com/technical/partners/ecommerce/shopify.md): Shopify Plus is an enterprise-level commerce platform designed for high-volume merchants.
- [OpenCart](https://docs.extole.com/technical/partners/ecommerce/opencart.md): Track order activity from your OpenCart storefront in Extole for attribution, rewarding, reporting, and segmentation.

#### Experimentation

- [Optimizely](https://docs.extole.com/technical/partners/experimentation/optimizely.md): Set up easy A/B testing for your Extole programs using Optimizely.

#### Loyalty

- [SessionM](https://docs.extole.com/technical/partners/loyalty/sessionm-loyalty-solution-guide.md): This guide will walk you through the technical steps for setting up a successful Extole referral program that integrates with your loyalty program powered by [SessionM](https://www.mastercardservices.com/en/solutions/consumer-engagement/sessionm).

#### Marketing Automation

- [Adobe Marketo Engage](https://docs.extole.com/technical/partners/marketing-automation/adobe-marketo-engage.md): Send data from your Extole Lead Generation or B2B program directly to the Marketo Lead API.
- [Attentive](https://docs.extole.com/technical/partners/marketing-automation/attentive.md): Set up a connection between your Extole programs and Attentive's SMS marketing platform.
- [Braze](https://docs.extole.com/technical/partners/marketing-automation/braze.md): Set up a connection between your Extole programs and Braze's customer-engagement platform.
- [Cordial](https://docs.extole.com/technical/partners/marketing-automation/cordial.md): Set up a connection between your Extole programs and Cordial's automated marketing platform.
- [Iterable](https://docs.extole.com/technical/partners/marketing-automation/iterable.md): [Iterable](https://iterable.com/) is the AI-powered cross-channel communication platform helping to orchestrate individualized, harmonized, and dynamic customer experiences by closing the activation gap.
- [Klaviyo](https://docs.extole.com/technical/partners/marketing-automation/klaviyo.md): Set up a connection between your Extole programs and Klaviyo's marketing automation platform.
- [Listrak](https://docs.extole.com/technical/partners/marketing-automation/listrak.md): Set up a connection between your Extole programs and Listrak's cross-channel marketing platform.
- [Optimove](https://docs.extole.com/technical/partners/marketing-automation/optimove.md): [Optimove](https://www.optimove.com/) is a CRM marketing platform that empowers marketers to drive measurable growth by planning, orchestrating, and optimizing marketing programs that start with the customer instead of a campaign or product..
- [Salesforce Marketing Cloud](https://docs.extole.com/technical/partners/marketing-automation/salesforce-marketing-cloud-opt-ins.md): Connect your Extole account to Salesforce Marketing Cloud to push data, typically a marketing email opt-in list. Extole can either push this through the Salesforce MC API or through Salesforce MC File Drop Automation.

#### OTT Platform

- [Vimeo OTT + Zapier](https://docs.extole.com/technical/partners/ott-platform/vimeo-ott-zapier.md): Set up a connection between your Extole programs and Vimeo's over-the-top streaming service platform in tandem with Zapier.

#### Rewards and Payments

- [BHN (Blackhawk Network)](https://docs.extole.com/technical/partners/rewards-and-payments/bhn.md): Integrate with BHN to reward program participants with open loop and closed loop products from BHN's robust catalogue.
- [Stripe](https://docs.extole.com/technical/partners/rewards-and-payments/stripe.md)
- [Tremendous](https://docs.extole.com/technical/partners/rewards-and-payments/tremendous.md): Integrate with Tremendous to set up international gift card, PayPal, Venmo, and ACH rewards for your Extole programs.

#### Tag Management

- [Ensighten](https://docs.extole.com/technical/partners/tag-management/ensighten.md): Set up Extole functionalities on your site using Ensighten tag management workflows.
- [Google Tag Manager](https://docs.extole.com/technical/partners/tag-management/google-tag-manager.md): Set up Extole functionalities on your site using Google Tag Manager. If you already have GTM integrated with your site, then all you need to do is create and configure Extole tags.
- [Tealium](https://docs.extole.com/technical/partners/tag-management/tealium.md): Set up Extole functionalities on your site using Tealium.

### Building Packaged Integrations

#### Integration Lifecycle

- [Build a Packaged Integration with the Management API](https://docs.extole.com/technical/building-custom-integrations/integration-lifecycle/management-api-integration.md): Package a partner platform as a reusable Extole integration through the Management API, with the Extole AI tools as the recommended build path.
- [Create the Integration Campaign and Component Model](https://docs.extole.com/technical/building-custom-integrations/integration-lifecycle/integration-component-model.md): Create the campaign, root, and model component with its display metadata, logo, typed sockets, and configuration view.
- [Add the Activity and Event Views](https://docs.extole.com/technical/building-custom-integrations/integration-lifecycle/integration-activity-views.md): Build the report-runner and event-stream views, create the report runner and event stream behind them, and publish so each view resolves its element.
- [Validate and Publish an Integration](https://docs.extole.com/technical/building-custom-integrations/integration-lifecycle/integration-validation.md): Gate outbound resources, validate the finished shape, publish the validated version, and connect the integration to a program.

#### Integration Types

- [Integration Categories](https://docs.extole.com/technical/building-custom-integrations/integration-types/integration-categories.md): Choose the category for a packaged partner integration — inbound, outbound, reward fulfillment, or bidirectional — and see what each one builds.
- [Build an Outbound Library Integration](https://docs.extole.com/technical/building-custom-integrations/integration-types/integration-build-outbound.md): Install a maintained partner source, reshape it to the shape the partner page defines, and attach its outbound webhooks and credential.
- [Build a Reward Fulfillment Integration](https://docs.extole.com/technical/building-custom-integrations/integration-types/integration-build-reward-fulfillment.md): Create the supplier type, support campaign, supplier templates, reward webhooks, and reward-specific views for a partner that fulfills rewards.
- [Map Inbound Partner Events](https://docs.extole.com/technical/building-custom-integrations/integration-types/integration-inbound-events.md): Add business events, input event rules, and event data to a packaged integration that receives partner events, then verify what arrives.
- [Receive Audience Membership from a Partner](https://docs.extole.com/technical/building-custom-integrations/integration-types/integration-inbound-audience-membership.md): Add the audience, credential, and setup instructions for a partner platform that manages audience membership in Extole.
- [Normalize Inbound Events with a Prehandler](https://docs.extole.com/technical/building-custom-integrations/integration-types/integration-prehandlers.md): Reshape a partner's own webhook at ingest so it can post directly to Extole.
- [Send Platform Events to Extole](https://docs.extole.com/technical/building-custom-integrations/integration-types/sending-platform-events.md): Deliver a platform's lifecycle events to the Extole Events API, with retries, deduplication, and verification.
- [How to Track a Friend Registration Event](https://docs.extole.com/technical/building-custom-integrations/integration-types/how-to-track-a-friend-registration-event.md): How to track a friend's registration as a distinct event before conversion, connect it to the later conversion with partner_conversion_id, and report on registrations.

### Solutions

- [Go Extole Field Team App](https://docs.extole.com/technical/solutions/go-extole-technical-docs.md): Mobile app where users share QR codes and links to refer and earn rewards

#### Extole Solution Guides

- [Extole Solution Guides](https://docs.extole.com/technical/solutions/extole-solution-guides/index.md)
- [Lead Generation](https://docs.extole.com/technical/solutions/extole-solution-guides/lead-generation.md): Quickly build an effective lead generation referral program to turn customers into advocates who become the source for your best leads.
- [Membership & Loyalty](https://docs.extole.com/technical/solutions/extole-solution-guides/membership-loyalty.md): Set up a membership and loyalty referral program with branded links, website tags, signup and purchase tracking, rewards, mobile integration, and optional enhancements.
- [Banking / Credit Unions](https://docs.extole.com/technical/solutions/extole-solution-guides/quick-banking.md): Quickly build an effective referral program to turn account holders and influencers into advocates who turn their passion for you into new account holders.
- [Retail](https://docs.extole.com/technical/solutions/extole-solution-guides/retail.md): Quickly build an effective referral program to turn customers into advocates and to turn the passion they have for you into new customers.
- [Subscription](https://docs.extole.com/technical/solutions/extole-solution-guides/subscription.md): Quickly build an effective subscription referral program to turn customers into advocates and to turn the passion they have for you into new subscribers.

##### Financial Services

- [Financial Services](https://docs.extole.com/technical/solutions/extole-solution-guides/financial-services/index.md): Quickly build an effective referral program to turn account holders and influencers into advocates who turn their passion for you into new account holders.

### Operational Tasks

#### Security & Compliance

- [Data Erasure Requests](https://docs.extole.com/technical/operational-tasks/security-and-compliance/data-erasure-requests.md): Make data erasure requests and understand what these requests mean at Extole.
- [Right to Access Requests](https://docs.extole.com/technical/operational-tasks/security-and-compliance/right-to-access-requests.md): Make General Data Protection Regulation (GDPR) and California Consumer Protection Act (CCPA) Right to Access requests.
- [Manage Your SSL Certificate](https://docs.extole.com/technical/operational-tasks/security-and-compliance/manage-your-ssl-certificate.md)
- [Verifying Consumers](https://docs.extole.com/technical/operational-tasks/security-and-compliance/verifying-consumers.md): For a consumer token to be used to get PII data about a consumer's friends (email, name, conversion history), the token must be verified to belong to the consumer.

#### Account Configuration

- [Develop Behind Your Firewall](https://docs.extole.com/technical/operational-tasks/account-configuration/develop-behind-your-firewall.md)
- [Extole DNS Requirements](https://docs.extole.com/technical/operational-tasks/account-configuration/extole-dns-requirements.md): Learn how to fully white label your program by setting up DNS entries.
- [Generate Long-lived Access Tokens](https://docs.extole.com/technical/operational-tasks/account-configuration/generate-long-lived-access-tokens.md): In your My Extole account, create long-lived access tokens to take advantage of our RESTful APIs.
- [My Extole Single Sign On](https://docs.extole.com/technical/operational-tasks/account-configuration/my-extole-single-sign-on.md): Read about the methods we support for SSO and SAML.
- [Opt-out List Management](https://docs.extole.com/technical/operational-tasks/account-configuration/opt-out-list-management.md): Learn about three types of opt-out lists we maintain for Extole-powered programs, what your options are for managing lists, and answers to our most frequently asked questions.
- [Recent Customer Purchase Upload](https://docs.extole.com/technical/operational-tasks/account-configuration/recent-customer-purchase-upload.md): Upload a list of recent customers who have made purchases from your business for targeting purposes.

#### Program Testing

- [Exclude Test Data from Analytics](https://docs.extole.com/technical/operational-tasks/program-testing/exclude-test-data-from-analytics.md): We support various methods for preventing test data from displaying in your My Extole dashboard analytics.
- [A/B Test Your Offer](https://docs.extole.com/technical/operational-tasks/program-testing/ab-test-your-offer.md): Learn how to set up A/B tests to optimize the reward you are offering in your Extole referral and engagement programs.
- [A/B Test Your Program](https://docs.extole.com/technical/operational-tasks/program-testing/set-up-ab-tests.md): Learn how to set up A/B tests to optimize the performance of your Extole referral and engagement programs.

### Troubleshooting

- [Why a CTA Opens a Different Program's Share Experience](https://docs.extole.com/technical/troubleshooting/why-a-cta-opens-a-different-programs-share-experience.md): Why a CTA can open a different program's share experience when several programs are live at once, and how to give each program its own share experience.