Skip to main content

Ghost integration

Setting up the Ghost integration​

  1. Go to Integrations. Click “Add” on the Ghost card.

    Ghost integration card

  2. Enter your (a) API key; (b) admin domain; (c) site URL.

    1. API keys can be generated for Ghost custom integrations. Find more details on Ghost custom integrations here.
    2. The admin domain is the one you use to log in, and should follow the pattern yourdomain.ghost.io .
    3. Your site URL can be different from your admin domain (e.g., if you host your content). For example, it could be yoursite.com/blog .

    Ghost integration inputs

  3. Optionally, adjust the settings. For more details on settings, read the section below.

  4. Click “Connect”. Your content will start syncing. Once synced, you can click on the card to see the imported docs.

    Ghost import success

Automatic syncs

If on a Growth or Enterprise plan, you can set up your content to sync automatically — either daily or weekly.

Ghost integration settings​

  1. Sync frequency: The frequency of syncs. Note: automatic syncs are only available on Growth and Enterprise tiers.

    1. Manual — synced manually
    2. Weekly — automatically synced weekly
    3. Daily — automatically synced daily

  2. Default visibility: If set to "Live", your help docs will immediately be searchable in Spotlight.

    Integration settings