---
title: "Connecting your Xtremepush instance"
slug: "connecting-your-xtremepush-instance"
updated: 2026-07-23T12:14:17Z
published: 2026-07-23T12:14:17Z
canonical: "docs.xtremepush.com/connecting-your-xtremepush-instance"
---

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

# Connecting your Xtremepush instance

The Xtremepush integration is the foundation of XpertOS. Once connected, your assistant and your flows can work with your campaigns, segments, tasks, and journeys. This guide walks through the connection step by step, including where to find each credential.

## Before you begin

You need three things from the Xtremepush project you want to connect:

- Your **app token**
- Your project's **external API endpoint url**
- Your **project ID**

The **app token** and **endpoint url** can be found in your Xtremepush project admin via: **Settings > Integrations > API Integration**

The **project ID** is present in the URL when logged into your Xtremepush project. For example: **project_id=3** (you will need only the number itself e.g. **3**)

## Connect an instance

1. Click **Settings** at the bottom of the XpertOS sidebar and open the **Integrations** tab.
2. Find **Xtremepush** in the list and click **Add Instance**.
3. Complete the connection form:
  - **Instance Name**: a friendly name you will recognise later, such as *Production*.
  - **The 3 pieces of information from above:**
    - **App Token**: your Xtremepush application token.
    - **External API URL**: the API endpoint for your instance.
    - **Project ID**: your Xtremepush project identifier.
4. Click **Add Instance**.

> [!WARNING]
> **The app token is not your login**
> 
> Do not enter your email address or password in the connection form. The **App Token** field takes a long application key generated by the Xtremepush platform as described above. It is not the password you log into the Xtremepush platform with.

## What happens after you connect

XpertOS syncs data from your instance so that campaigns and segments are quick to browse and search. The first sync can take a little while on projects with a large campaign history. After that, data refreshes on a regular schedule: a light refresh through the day and a full sync daily.

Once the sync completes, you can do the following:

| Area | What you can do |
| --- | --- |
| **Campaigns** | Browse, inspect, create (as drafts), and update campaigns |
| **Audiences, Segments, and Lists** | Browse and inspect audience segments and lists |
| **Tasks** | View task history and execution details |
| **Tags/Attributes** | Browse and use for segmentation and dynamic content |

> [!TIP]
> **Drafts and approvals keep you in control**
> 
> Any campaign an Xpert creates lands in Xtremepush as a draft, and actions that change your live systems wait for your approval in the Inbox.
> 
> Nothing sends without a human saying so.

## Connect more than one instance

If you work across several Xtremepush projects, repeat the steps above for each one. Each instance keeps its own credentials and data. When you have multiple instances connected:

- In **chat**, an instance picker appears near the message box.
- In **flows**, you set the instance on some Xtremepush blocks.
- In **briefs**, you choose the instance when creating the brief.

In each case check before you send submit or save to make sure the assistant is accessing the right data and is creating items in the right instance. Naming instances clearly, for example *Production* and *Test*, help you to always know which one you are working with.

> [!NOTE]
> No cross-tenant or cross-brand view
> 
> Even when multiple Xtremepush instances are connected to XpertOS it is worth noting that any conversation or running flows/crew-briefs are scoped to a single instance at a time. It is not possible to reference data from, or create content in, multiple projects at the same time. These must remain separate actions with the user selecting which project to work with in each request.

## Keeping data fresh

To refresh synced data manually, open **Settings > Integrations**, find your Xtremepush instance, and click the **Sync** button. If older campaigns are missing, use the **Full Sync** action, available via the dropdown arrow, to pull your complete campaign history.

Agents are also intelligent enough to know that if a specific request requires fresh data then they will automatically trigger a sync before pulling it in.

## Troubleshooting

- **"apptoken is invalid"**: the app token is wrong, incomplete, or from a different project. Re-copy it and check the project ID matches.
- **Connection succeeds but data is missing**: the first sync may still be running, or older campaigns need a **Full Sync**.
- **"Sync already in progress"**: a sync is running. Wait for it to finish before triggering another.
- **The wrong data appears in chat**: check the instance picker. You may be querying a different instance than you expect.

## What’s next

With Xtremepush connected, add your other tools in [Connecting other integrations](/documentation/docs/connecting-other-integrations), then give your Xperts context in [Setting up your Knowledge Base](/documentation/docs/setting-up-your-knowledge-base).