Set up a FreshBooks connector

Capabilities

Resource	Sync	Provision
Users
Roles

Gather FreshBooks credentials

Configuring the connector requires you to pass in credentials generated in FreshBooks. Gather these credentials before you move on.

A user with access to the FreshBooks Developer site must perform this task.

Create a FreshBooks app

Log into the FreshBooks Developer site.

Navigate to the Apps page and click Create New App.

Give the app the following scopes:

user:profile:read
user:teams:read
user:account:read
user:teams:write
user:account:write

Enter https://accounts.conductor.one/oauth/callback as the Redirect URI.

Save the app.

On the Apps page, click the new app’s name. Carefully copy and save the app’s Client ID and Client secret.

Click Go to authentication page.

Click Allow. The application is authorized. Carefully copy and save the authorization code.

Self-hosted only: Generate a refresh token

Run the following curl command, filling in the variables as noted:

curl -X POST https://api.freshbooks.com/auth/oauth/token \
-d 'grant_type=authorization_code' \
-d 'client_id=<58f1...>' \
-d 'client_secret=c4a8...' \
-d 'code=8749...' \
-d 'redirect_uri=https://awesomeonlinestore.example/redirect'

The response will look like this:

{
  "access_token":"eyJra...",
  "token_type":"Bearer",
  "expires_in":43200,
  "refresh_token":"818c...",
  "scope":"user:profile:read user:clients:read user:expenses:read","created_at":1747105792,
  "direct_buy_tokens":{}
}

Carefully copy and save the refresh token.

Done. Next, move on to the connector configuration instructions.

Configure the FreshBooks connector

To complete this task, you’ll need:

The Connector Administrator or Super Administrator role in C1
Access to the set of FreshBooks credentials generated by following the instructions above

Cloud-hosted
Self-hosted

Follow these instructions to use a built-in, no-code connector hosted by C1.

In C1, navigate to Apps > Connectors and click Add connector.

Search for FreshBooks and click Add.

Choose where to add the connector: Create a new app, or Add to an existing app (then select the app).If you’re creating a new app, choose whether to link it to an application discovered from your identity provider: select Yes and pick the IdP application, or No to continue with just the connector.

Set the connector’s Name and, optionally, a Description.

Click the pencil icon next to Owners to choose who can configure and manage this connector.

Click Add. The connector is created and its configuration page opens.

Find the Settings area of the page and click Edit.

Paste your FreshBooks credentials into the relevant fields.

Click Save.

Click Login with OAuth and follow the prompts.After authenticating with FreshBooks, you’ll be redirected back to the connector setup page in C1, where you’ll see an authorization message.

The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

Done. Your FreshBooks connector is now pulling access data into C1.

Follow these instructions to use the FreshBooks connector, hosted and run in your own environment.When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

Resources

GitHub repository: Access the source code, report issues, or contribute to the project.

Step 1: Set up a new FreshBooks connector

In C1, navigate to Apps > Connectors and click Add connector.

Search for Baton and click Add.

Set the connector’s Name and, optionally, a Description.

Click the pencil icon next to Owners to choose who can configure and manage this connector.

Click Add. The connector is created and its configuration page opens.

In the Settings area of the page, click Edit.

Click Rotate to generate a new Client ID and Secret.Carefully copy and save these credentials. We’ll use them in Step 2.

Step 2: Create Kubernetes configuration files

Create two Kubernetes manifest files for your FreshBooks connector deployment:

Secrets configuration

# baton-freshbooks-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-freshbooks-secrets
type: Opaque
stringData:
  # C1 credentials
  BATON_CLIENT_ID: <C1 client ID>
  BATON_CLIENT_SECRET: <C1 client secret>
  
  # FreshBooks credentials
  BATON_FB_CLIENT_ID: <FreshBooks client ID>
  BATON_FB_CLIENT_SECRET: <FreshBooks client secret>
  BATON_REFRESH_TOKEN: <FreshBooks refresh token>

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# baton-freshbooks.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-freshbooks
  labels:
    app: baton-freshbooks
spec:
  selector:
    matchLabels:
      app: baton-freshbooks
  template:
    metadata:
      labels:
        app: baton-freshbooks
        baton: "true"
        baton-app: freshbooks
    spec:
      containers:
      - name: baton-freshbooks
        image: public.ecr.aws/conductorone/baton-freshbooks:latest
        imagePullPolicy: IfNotPresent
        env:
        - name: BATON_HOST_ID
          value: baton-freshbooks
        envFrom:
        - secretRef:
            name: baton-freshbooks-secrets

Step 3: Deploy the connector

Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.

Check that the connector data uploaded correctly. In C1, click Apps. On the Managed apps tab, locate and click the name of the application you added the FreshBooks connector to. FreshBooks data should be found on the Entitlements and Accounts tabs.

Done. Your FreshBooks connector is now pulling access data into C1.

Welcome

Manage connectors

Deploy connectors

Upload connector data

Configurable connectors

Pre-built connectors

Set up a FreshBooks connector

Capabilities

Gather FreshBooks credentials

Create a FreshBooks app

Self-hosted only: Generate a refresh token

Configure the FreshBooks connector

Resources

Step 1: Set up a new FreshBooks connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector

​Capabilities

​Gather FreshBooks credentials

​Create a FreshBooks app

​Self-hosted only: Generate a refresh token

​Configure the FreshBooks connector

​Resources

​Step 1: Set up a new FreshBooks connector

​Step 2: Create Kubernetes configuration files

​Secrets configuration

​Deployment configuration

​Step 3: Deploy the connector

Capabilities

Gather FreshBooks credentials

Create a FreshBooks app

Self-hosted only: Generate a refresh token

Configure the FreshBooks connector

Resources

Step 1: Set up a new FreshBooks connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector