Staffbase Connector

Index resources such as Users, Campaigns, Posts, and Comments from your Staffbase platform.

The Staffbase connector enables indexing of various resources from your Staffbase platform, including Users, Campaigns, Posts, and Comments. This integration allows you to search and access Staffbase content directly through Atolio.

Set Up Administrator API Key and Retrieve Base URL

To set up the Staffbase connector, you’ll need to create an API key with administrator privileges. Follow these steps:

  1. Log in to your Staffbase account as an administrator.

  2. Navigate to the Admin Panel:

    a. Click your user profile at the top right, then click ‘Studio’ in the drop-down menu.

    Studio drop-down menu

    b. Click the gear icon at the top right corner.

    Gear icon in the corner of the page

    c. In the new page, you will see a column on the left. Click the ‘API Access’ tab.

    API Access tab

  3. Click the “Create New API Key” button.

  4. Provide a descriptive name for the key, such as “Atolio Connector”.

  5. Under “Access”, select “Read-only” to ensure full access to all resources.

  6. Click “Create”.

  7. Copy the generated API key. You won’t be able to view it again. You’ll provide it as described in Required Configuration Values.

  8. On the same page, you’ll also see the base URL for your instance: Base URL location

Required Configuration Values

Enter these values in the Atolio Admin console (v4.24 and later), or send them to Atolio Support (your Deployment Engineer).

ValueWhere to find itExample / formatSecret
Base URLStep 8, shown on the API Access pagehttps://yourcompany.staffbase.comNo
API keyStep 7, the API key you generatedLong random stringYes

Keep secrets secure: Share values marked “Yes” in the Secret column only through a password-manager share (e.g. 1Password) or another secure channel agreed with Atolio Support. Never send them in plain email, chat, or support tickets.

Configuration Example

Add this block to connector-values.yaml. Replace each <PLACEHOLDER> with the matching value from the table above, and remove any line marked “Only if” that doesn’t apply.

connectors:
  staffbase:
    default:
      staffbase:
        connector: staffbase
        instance: default
        source: staffbase
        common:
          enabled: true
          identity-provider: false
          cron-spec: "0 7 * * *"  # Staffbase is only synced on this schedule
        secrets:
          token:
            value: "<API_KEY>"
        configuration:
          base-url: "<BASE_URL>"