​

Set Up the Causeway Connector

1. A one-time OAuth setup performed by an admin, which registers Causeway as an OAuth connector in Airia.
2. Creating a Causeway data source, where each user authenticates with their Causeway credentials and selects the folders to ingest.

​

Prerequisites

• A Causeway account with access to the workgroup folders you want to ingest.
• Your Causeway connection details:
  • Instance URL — the base URL of your Causeway tenant.
  • Username
  • Password
• A registered Causeway OAuth connector in your Airia tenant (see Set Up the Causeway OAuth Connector below). This is a one-time setup performed by an admin.

​

Set Up the Causeway OAuth Connector

​

1. Register an OAuth 2.0 client with Causeway

1. Contact your Causeway administrator (or Causeway support) and request an OAuth 2.0 client registration for Airia. You will need to provide:
   • Application name — for example, Airia Knowledge.
   • Redirect URI — your Airia OAuth callback URL: https://<your-airia-api-host>/v2/OAuth/callback. You can find this in Airia under Settings → OAuth Connectors → New → Callback URL.
   • Grant types — Authorization Code (plus Refresh Token, if your Causeway tenant offers it).
   • Scopes — openid and offline_access. offline_access lets Airia refresh the access token automatically during long folder browsing and ingestion runs, so users don’t have to re-authenticate.
2. After registration, Causeway returns:
   • Client ID
   • Client Secret — copy and store it securely; Causeway typically shows the secret only once.
   • Authorization endpoint — usually https://<causeway-oauth-host>/oauth/authorize.
   • Token endpoint — usually https://<causeway-oauth-host>/oauth/token.
3. Confirm with Causeway that the token endpoint accepts Client Secret Post authentication (client credentials sent in the request body). Airia uses this method by default for Causeway. If your Causeway instance only supports Client Secret Basic, note it for the next step.

​

2. Register Causeway as an OAuth connector in Airia

​

Option A — Airia UI

1. In the Airia platform, navigate to Settings → OAuth Connectors → New.
2. Choose the Generic OAuth provider type.
3. Enter the details you collected from Causeway:
   • Name — a recognizable display name, e.g. Causeway or Causeway (Production).
   • Client ID and Client Secret — from Step 1. The secret is encrypted at rest.
   • Authorization endpoint and Token endpoint — the exact URLs Causeway provided.
   • Scopes — openid and offline_access.
   • Token Endpoint Auth Method — select Client Secret Post. (Select Client Secret Basic only if your Causeway instance requires Basic auth on the token endpoint.)

   💡 Important: Setting Token Endpoint Auth Method to Client Secret Post is the most common cause of setup issues if missed. Make sure it is selected.

4. Click Create. The new Causeway connector appears under Settings → OAuth Connectors → Connected, where it can be edited or deleted later.

​

Option B — Platform API

curl --request POST \
  --url https://<your-airia-api-host>/v2/OAuth/providers \
  --header 'Authorization: Bearer <YOUR_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Causeway",
    "provider": "GenericOAuth",
    "authenticationType": "StaticUserOauth",
    "clientId": "<CAUSEWAY_CLIENT_ID>",
    "clientSecret": "<CAUSEWAY_CLIENT_SECRET>",
    "authorizationEndpoint": "https://<causeway-oauth-host>/oauth/authorize",
    "tokenEndpoint": "https://<causeway-oauth-host>/oauth/token",
    "revokeEndpoint": "",
    "supportedScopes": ["openid", "offline_access"],
    "behaviour": {
        "tokenEndpointAuthMethod": "CLIENT_SECRET_POST"
    }
}'

💡 Updating credentials later: If the Causeway client secret rotates, an admin can update the connector (UI) or PUT /v2/OAuth/providers/{id} with the new clientSecret. Existing user credentials issued under the old secret keep working until they expire; new authentications use the updated secret.

​

Register Your Causeway Credentials

1. In the Airia platform, navigate to Settings → Credentials and click Add Credentials.
2. Enter a descriptive Name that will help you identify it later (e.g., Causeway – Production).
3. Select Causeway as the credential type.
4. Enter your Causeway connection details:
   • Instance URL — the base URL of your Causeway tenant.
   • Username
   • Password
5. Select the Scope the credential applies to.
6. Click Create.

​

Create a Causeway Data Source

​

1. Add a New Causeway Data Source

1. In your project, navigate to Data Sources and click Add data source.
2. Select Causeway from the Communication & Collaboration category in the connector library.

​

2. Authenticate with Causeway

1. Click Authenticate with Causeway.
2. Choose your credential:
   • Select an existing credential — if you already registered a Causeway credential (see Register Your Causeway Credentials), select it from the list.
   • Create a new credential — enter the three required fields:
     • Causeway Instance URL — the base URL of your Causeway tenant.
     • Causeway Username
     • Password
3. A credential created here is saved and can be reused across other data sources in your tenant.

​

3. Select Folders to Ingest

• You can select entire folders, individual subfolders, or a mix. A folder appears partially selected when only some of its children are selected.
• Selecting a folder syncs everything within it, including subfolders and their files.
• If your access token is refreshed during selection, Airia stores the updated tokens automatically — no re-authentication needed.

​

4. Finish Setup and Monitor Ingestion

​

How Sync Works

​

Editing Your Folder Selection

💡 Note: If you re-authenticate with different Causeway credentials, the folder picker will not show your previous selections, and you will need to reselect everything.

​

Permissions

​

Troubleshooting

​

Next Steps