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

# Ghost Integration

> Bidirectional member sync, label management, tier mapping, and real-time automation between Outpost and your Ghost CMS site.

Ghost is Outpost's primary integration. Your Ghost site is the source of truth for members, subscriptions, tiers, and content. Outpost connects to Ghost to read that data and layer on growth, retention, and automation tools.

![Ghost integration settings with Content API key, Admin API key, API URL, and webhook URL fields](https://mintcdn.com/outpost-eb0cfbad/-cSE19cqpLAJyGqt/images/integrations/ghost-settings.png?fit=max\&auto=format\&n=-cSE19cqpLAJyGqt\&q=85\&s=ed46a412d97d84f6045e17aec1c4307e)

Ghost connection settings in Core Connections showing API keys, URL, and webhook configuration

> [!NOTE]
>
> For initial setup instructions, see [Connecting Ghost](https://documentation.outpost.pub/getting-started/connecting-ghost.md).

***

## How it works

1. You connect Outpost to Ghost using Content API and Admin API keys
2. Outpost sets up real-time notifications on your Ghost site to receive member, tag, and site settings events
3. When a member is created, updated, or deleted in Ghost, Outpost updates its records automatically
4. When Outpost applies or removes a label, it updates the member in Ghost to match
5. Tiers, posts, tags, and newsletter segments are read from Ghost to drive Outpost's automation and targeting

***

## What syncs

| Data | Direction | When |
| - | - | - |
| Members (create, update, delete) | Ghost → Outpost | Real-time |
| Labels | Outpost → Ghost | On change |
| Tags | Ghost → Outpost | Real-time |
| Posts | Ghost → Outpost | On-demand, and real-time once you turn on site search or use Events |
| Tiers | Ghost → Outpost | On-demand, and whenever Ghost reports a change to your site settings |
| Newsletter segments | Ghost → Outpost | On-demand |
| Site details (URL, name, time zone) | Ghost → Outpost | On-demand |
| Site icon (used as your logo) | Ghost → Outpost | On-demand, and only while Outpost has no logo of its own |
| Support email address | Ghost → Outpost | On-demand, and only while Outpost has no sender address of its own |

Ghost is the **source of truth** for members, subscriptions, and tiers. Stripe billing flows directly between Stripe and Ghost. Outpost reads that data to drive automation, segmentation, and conversion tools.

> [!WARNING]
>
> Outpost does not create or modify Ghost tiers, subscriptions, or posts. It reads this data and writes labels back to Ghost, and creates a Ghost member when an Outpost-side action (like adding a complimentary member) needs one that doesn't exist yet.

***

## Connection settings

The Ghost connection is configured under **Core Connections** in the left navigation. The settings include:

| Field | Description |
| - | - |
| **Content API Key** | Read-only key for accessing published content (posts, tags, tiers). Found in Ghost Admin → Integrations → Custom Integration. |
| **Admin API Key** | Read/write key for member and label operations. Found in the same Ghost custom integration. |
| **API URL** | Your Ghost site's URL (e.g., `https://yoursite.com`). |
| **Webhook URL** | Read-only URL that Outpost provides. This is where Ghost sends webhook notifications. |
| **External webhook for new members** | Optional URL to receive notifications when new members are added. Useful for triggering external workflows. |

***

## Member sync

```mermaid theme={"theme":{"light":"github-light","dark":"github-dark"}}
flowchart LR
    subgraph G[Ghost]
        GM[Member<br/>record]
    end
    subgraph O[Outpost]
        OM[Member<br/>record]
        OL[Labels &<br/>automation]
    end
    GM -->|signup, subscribe,<br/>cancel, tier change| OM
    OM --> OL
    OL -->|label add/remove| GM
```

### Ghost → Outpost

When a member event occurs in Ghost, Outpost automatically:

1. Creates or updates the matching member record in Outpost
2. Syncs subscription status, tier, and payment information
3. Applies any matching auto-subscribe rules for newsletters
4. Updates segments and triggers any label-based automation flows
5. Records the event in the [Activity Log](https://documentation.outpost.pub/features/activity-log.md)

### Outpost → Ghost

When Outpost applies or removes a label (via automation, bulk action, or manual change):

1. Outpost updates the member's labels in Ghost to match
2. Ghost reflects the change in its member portal
3. Any Ghost-side automations tied to that label are triggered

***

## Tiers

Tiers are created and managed in Ghost. Outpost reads them so they're available for:

* Member filtering and segmentation
* Offer and access rule configuration
* Automation trigger conditions (e.g., "when a member upgrades to Premium tier")
* Email campaign targeting
* [Subscription schedules](https://documentation.outpost.pub/features/subscription-schedules.md) and [complimentary subscriptions](https://documentation.outpost.pub/features/complimentary-subscriptions.md)

***

## What Outpost monitors

Outpost sets up notifications on your Ghost site as soon as you connect. These are the events it listens for:

| Event | Purpose |
| - | - |
| Member added | A new member was created in Ghost |
| Member updated | A member changed (email, name, subscription, tier, labels), including when a member cancels |
| Member deleted | A member was removed from Ghost |
| Tag added, updated, or deleted | Keeps Outpost's copy of your Ghost tags current |
| Site changed | Your Ghost site settings changed. Outpost uses this to refresh your tier list. |

When a paying subscriber cancels or reinstates auto-renewal, Outpost detects the change from Ghost's member update and from Stripe. Cancellation of auto-renewal triggers the cancellation emails and the staff notification, and both changes are recorded in the Activity Log. When a change arrives from both Ghost and Stripe, Outpost only processes it once.

If you change tier settings in Ghost, Outpost picks this up. Other changes, such as your site name, URL, or time zone, aren't brought over automatically: use the **Refresh Site Settings** tool to sync them, as described under [Manual resync](#manual-resync). Ghost's site icon becomes your logo in the same refresh, but only if Outpost doesn't already have a logo. Ghost's support email address comes across in the same refresh, but only if Outpost has no sender address of its own. Depending on how your site sends email, that field is **Email Reply-to Address** or **Email from address** in [Email Design Settings](https://documentation.outpost.pub/features/email-design-settings.md).

Notifications to Outpost from Ghost about your posts are set up separately rather than at connection. Outpost adds them when you turn on [site search](https://documentation.outpost.pub/integrations/typesense.md) or the deprecated [Algolia integration](https://documentation.outpost.pub/integrations/algolia.md), and when you open your [Events](https://documentation.outpost.pub/features/events.md) list. These tell Outpost about posts added, updated, and deleted, and site search adds the same three for pages. Saving your Ghost connection settings re-registers these post and page notifications too, so they stay in place after you update your API keys or reconnect Ghost.

***

## Sync checks

Day to day, your members and labels stay current through real-time updates from Ghost. To catch anything that falls out of step, a full check against Ghost compares your member counts and labels and repairs what it finds: renamed labels are updated, labels deleted in Ghost are removed, and member counts are resynced. If Ghost's label list can't be read, or comes back missing most of your labels, the check leaves your labels alone rather than removing them, and the Outpost team reviews it.

Outpost runs this check automatically every three hours. If you'd rather not wait for the next one, [refreshing your site data](#manual-resync) is the quickest fix for most differences.

Each time the check runs, it allows for a small amount of normal variation in member counts (under roughly half a percent of your total, and always at least a couple of members) so it isn't chasing one or two people who just signed up or changed tiers. Once a gap grows past that, it resyncs. If the difference is very large, it deliberately holds off on fixing everything at once so it doesn't overwhelm your Ghost site with requests, and the mismatch is flagged for the Outpost team to resync safely instead.

***

## Manual resync

If sync gets out of state, refresh your site data from **Account → Publication Details**. In the **Refresh Site Settings** card:

* **Site data**: Re-imports your Ghost members, labels, and tags, updating existing records and creating new ones. Outpost emails you when it finishes.
* **Site settings**: Brings your site's details over from Ghost (URL, name, time zone, and tiers) without touching member data. Ghost's URL, name, and time zone replace any you changed in Outpost. Your logo and sending address stay as you set them: Outpost only fills them from Ghost's site icon and support email address when they're empty. The sending address is the **Email Reply-to Address** or **Email from address** field in [Email Design Settings](https://documentation.outpost.pub/features/email-design-settings.md), depending on how your site sends email. To use a new site icon from Ghost, see [Site Logo](https://documentation.outpost.pub/features/publication-details.md#site-logo). If your site's URL has changed in Ghost, Outpost also updates the parts of your setup that still use the old URL.

Turn on the option you need and click **Refresh**.

> [!TIP]
>
> A refresh is useful after initial setup, after restoring a Ghost backup, after bulk changes in Ghost (imports or bulk label edits), or any time you suspect members are out of sync. It runs in the background, and on large sites it can take several minutes.

***

## Ghost API version

Outpost uses the Ghost Admin API v5. Your Ghost site must be running **Ghost 5.x or later**.

***

## Large sites

For sites with large member counts, Outpost automatically manages sync performance:

* Bulk sync operations are spread out over time
* Member updates are processed in batches
* Failed requests are retried automatically

***

## Related features

> [card] [Stripe Integration](https://documentation.outpost.pub/integrations/stripe.md)
>
> Stripe works alongside Ghost for subscription billing.

> [card] [Activity Log](https://documentation.outpost.pub/features/activity-log.md)
>
> View Ghost sync events and errors.

> [card] [Spam Filtering](https://documentation.outpost.pub/features/spam-filtering.md)
>
> Filter spam members synced from Ghost.

> [card] [Members](https://documentation.outpost.pub/features/members.md)
>
> Manage the member records synced from Ghost.

> [card] [Ghost Compatibility FAQ](https://documentation.outpost.pub/faq/ghost-compatibility.md)
>
> Which Ghost versions, themes, and features Outpost works with.

> [card] [Publication Details](https://documentation.outpost.pub/features/publication-details.md#membership-features)
>
> The **Use Ghost Portal for membership features** setting decides whether Outpost's CTAs, reader polls, and events send readers to Ghost Portal or to your own membership pages.

***

## FAQ

> [accordion] Do I need to create a custom integration in Ghost?
>
> Yes. Go to Ghost Admin → Settings → Integrations → Add Custom Integration. This gives you the Content API key and Admin API key that Outpost needs.

> [accordion] What happens if I disconnect Ghost?
>
> Outpost stops receiving member updates. Existing member data in Outpost is preserved, but it will become stale as Ghost members change. Labels applied by Outpost will remain in Ghost.

> [accordion] Why are some members not syncing?
>
> Check the [Activity Log](https://documentation.outpost.pub/features/activity-log.md) for sync errors. Common causes include incorrect API keys or connection issues on high-volume sites. Use the manual resync option to re-import all members.

> [accordion] Why is my member count slightly different in Outpost and Ghost?
>
> A small difference is normal and expected. Here's why:
>
> * **Sync timing and tolerance.** Members sync from Ghost in real time, so a total can lag by a member or two while updates arrive. A full count check against Ghost tolerates a tiny gap by design (under about half a percent of your total, and always at least a couple of members) so it isn't chasing one or two people who just signed up, were removed, or changed tiers. Once a gap crosses that point, the check resyncs. A very large gap (say, right after a bulk import) is flagged for the Outpost team to resync safely instead.
> * **Marketing campaigns leave out opted-out members.** When you build an email campaign and mark it as a marketing email, Outpost automatically excludes anyone who has opted out of marketing (members with the `Marketing_OptOut` label) when it works out who will receive it. That makes a campaign's audience smaller than your overall member count, even with the same tier or segment selected. New campaigns are treated as marketing by default, and you can see or adjust the excluded labels in the campaign's audience settings.
> * **Labels applied in bulk in Ghost.** These do not change your member totals, but Ghost's bulk **Add label** and **Remove label** actions do not reach Outpost right away, so audiences filtered on that label can briefly count too few or too many members. Refreshing your site data brings the two back in line. See [labels](https://documentation.outpost.pub/features/labels.md) for details.
>
> If the gap is large or doesn't close on its own, [refresh your site data](#manual-resync), and check the [Activity Log](https://documentation.outpost.pub/features/activity-log.md) for sync errors.

> [accordion] Can Outpost create members in Ghost?
>
> Usually members are created in Ghost (via signup forms, Stripe checkout, or import) and synced to Outpost automatically. Outpost does create a Ghost member when an Outpost-side action needs one that doesn't exist yet: for example, when you add a member manually in Outpost or grant a complimentary subscription to someone who isn't in Ghost.

> [accordion] Does Outpost support Ghost's native newsletter feature?
>
> Outpost reads Ghost's newsletter segments and member newsletter preferences. It uses this data for targeting but does not send emails through Ghost: all emails are sent via Outpost's built-in Mailgun infrastructure. No separate Mailgun setup is required.


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