> ## Documentation Index
> Fetch the complete documentation index at: https://support.configview.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Extole setup

Configview reads your Extole account (the referral and loyalty marketing platform) through the **Extole Management API** (`https://api.extole.io`), using a long-lived **access token** from My Extole. Configview sends only `GET` requests. It never creates, changes, publishes or deletes anything in Extole.

You will end up with **1 required secret** (`EXTOLE_ACCESS_TOKEN`) in Configview when setup is complete.

> **Scope of this integration today.** Configview answers "who can change our referral and loyalty programs, which tokens can call the API, and where does Extole send data": admin users and their scopes, access token metadata, every campaign (name, state, program type, publish dates), the campaign edit history by editor, webhooks by destination host, and custom client domains. It does **not** read advocates, referral participants, rewards, reward codes, token values or campaign content (copy, themes, landing pages).

***

## What you need

* An Extole client account and a user who can open the Security Center
* A user with **read-only scopes** to create the token (the token carries the scopes of its creator)

***

## Step 1: Open the Extole page in Configview

Open Configview in a second browser tab and leave it open:

`https://{companyname}.configview.com/admin/integrations/extole`

***

## Step 2: Create the access token

1. Log in to My Extole and open **Security Center**
2. In the **Access Token** section click **+ New Access Token** and verify your identity
3. Name it `Configview` and click **Create**
4. Copy the token (it is shown once)
5. In the Configview tab paste it into `EXTOLE_ACCESS_TOKEN` under **Credentials** and save

Create the token while signed in as a user that holds only read scopes where possible. Configview needs to list users, managed tokens, campaigns, campaign versions, webhooks and client domains.

***

## Step 3: Connect and verify

1. Click **Connect**. Configview creates its tables and schedules every collector at your default run time:

| Script | Notes |
| - | - |
| **Users** | Admin users: email, name, locked, scopes, last login. |
| **Access tokens** | Token name, created and expiry. Never the value. |
| **Campaigns** | Name, state, program type, publish and schedule dates. |
| **Audit logs** | Campaign version history: editor, created, published. |
| **Webhooks** | Name, type, enabled, destination host. |
| **Client domains** | Custom domains, HTTPS, proxy, certificate policy. |

2. Click **Verify now**. The health check reads the secret, then lists users.

If a check fails:

* **401.** The token is wrong, revoked or expired.
* **403.** The token's scopes cannot read that area.

***

## Data Tables

Each table has a `run_at` column and keeps only the newest run.

| Table | Source | Key Columns |
| - | - | - |
| `extole_users` | `GET /v2/users` | user\_id, email, locked, scopes, last\_logged\_in |
| `extole_access_tokens` | `GET /v4/tokens/managed` | access\_token\_id, name, created\_at, expires\_at |
| `extole_campaigns` | `GET /v2/campaign-summaries` | campaign\_id, name, state, program\_type, is\_published, last\_published\_date |
| `extole_audit_logs` | `GET /v2/campaigns/{campaignId}/versions` | campaign\_id, version, editor\_id, editor\_type, created\_at, published\_at |
| `extole_webhooks` | `GET /v6/webhooks/built` | webhook\_id, name, webhook\_type, enabled, url\_host |
| `extole_client_domains` | `GET /v1/client-domains` | domain\_id, domain, is\_extole\_domain, secure, proxy |

***

## Things worth knowing

**Tokens.** The managed token list returns the token value itself; Configview never reads it and keeps only name, id, created and expiry. A token with no expiry stays valid until revoked.

**Edit history.** Extole has no client-wide audit log. The version history of each campaign is the change log, so the audit table needs one request per campaign, up to 500 versions each. `editor_id` and `user_id` join to `extole_users.user_id`; changes made by Extole itself show as a system editor.

**Webhooks.** Extole webhooks are called by campaigns, not subscribed to events, so there are no event names. Only the destination host is kept.

**Rate limit.** Extole does not publish a numeric limit for the Management API. Configview paces itself at 60 requests a minute and waits as long as Extole asks on HTTP 429.

## Known gaps

* No aggregate referral or reward counts: Extole produces those through asynchronous reports created with `POST`, which would write to your account, so Configview does not run them
* Client keys (signing secrets) are not collected
* Role names are not exposed; access is shown as the scope list on each user

## What isn't collected

* Advocates, participants, referrals, rewards and reward codes
* Access token values, client key secrets, certificates and private keys
* Campaign copy, themes, landing pages and version commit messages
* Webhook URLs beyond the host, request bodies and headers


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.