Seamlessly move data into and out of WorkBoardAI with our API for developers.

Choose our native integration or build your own app

Consolidate Results

Source metrics and key results for WorkBoard goals from your existing business applications.

Promote Accountability

Develop custom views of your team's goal progress for greater transparency across the organization.

Manage User Accounts

Integrate with HRIS systems to create or delete user accounts as employees join or leave your company.

Business Integration Flow

Move data into and out of WorkBoardAI in several ways. We have a set of integrations built into the app itself — native integrations with apps like Microsoft Teams, Slack, Outlook and Google calendar that users can integrate in just a few seconds on their profile page, as well as connectors to PowerBI, Salesforce, Azure DevOps, Monday.com, Jira and many more that allow users to set them as metric sources when creating OKRs. We also provide pre-built connectors for real time integration with Excel, Google spreadsheets and .csv files — these take just a few minutes to connect and any user can do it. Developers can use our RESTful API to quickly write connectors to other data sources and your specific data set in an hour or two.

Agent Access to API
‍Agent-based access to WorkBoard APIs requires an active WorkBoardAI platform subscription and Agent-Tier API licenses (or equivalent AI credit allocation).

Frequently asked questions

How hard is it to write a connector for our business systems?

It is easy and we’ve followed the RESTful API architecture, a standard most developers and IT teams are very familiar with using. In our API documentation, you'll find scripts, snippets and examples to walk authors through creation and testing connectors.

What systems can integrate with WorkBoardAI?

Besides native integrations with Microsoft Teams, Slack, Outlook, Google calendar, JIRA, Asana, Salesforce and more, developers can use our API to integrate business systems such as Zendesk, Marketo, SAP, and many more.

What authentication methods does WorkBoardAI support?

Each call you make to the API must be authenticated with an access token. WorkBoard offers two methods for requesting an access token: instant tokens, and OAuth 2.0 authentication.

If you are testing the API or are developing a single-user application, you can get an access token with a single click using Instant Token Authentication. To get your Instant Token, click here, then click on the Instant token link. A token will be generated for you immediately.

However, if you are developing an app for multiple users, we recommend using OAuth 2.0 for authentication. This will allow WorkBoard to dynamically authenticate any of your app users to give them access:

Register your app

To start using WorkBoard's API, you first need to register your application on WorkBoard (click on the "App" tab). You will be asked to provide the following information:
- App Name - A name for your application.
- App Description - A short description of your application.
- App Redirect URI - You must provide a redirect URI for authentication. It will be matched with the URI that you pass in the OAuth request. (Be sure to save this URI for use in your future requests)
- Contact Person Email Address - If an error occurs, the WorkBoard API will send a notification to this address.
Once you have created an app, you will receive a Client ID (which will identify your app to the WorkBoard API), and a Client Hash. Both of these will be used in the OAuth authentication process.

Important: Remember to treat your Client Hash like a password. It can be used to access your organization's WorkBoard data, so be sure to store it somewhere safe!

Request an authorization code

To start the authorization process, submit a request to the authorization URL. Include the parameters listed below.

Authorization URL: https://www.myworkboard.com/wb/oauth/authorize

Parameters
client_id	The Client ID you received when you registered your app (Required)
redirect_uri	The URL in your app to which WorkBoard will redirect after authorization
scope	A comma-separated list of scopes. In WorkBoard API v1.0, the default value is "all." (Optional)
state	A random string, used to protect against cross-site request forgery attacks. WorkBoard will redirect to the specified redirect_uri with the same value passed in the state parameter. If the two values don't match, the access call should be aborted. (Optional)
response_type	If you prefer to receive the authorization code over JSON response (not recommended), set the value of response_type to "json_code." (Optional)

Once you have successfully submitted your authorization request, you will be redirected to the redirect_uri that you provided, with the code parameter set to the authorization code.

If an authorization error occurs, you will be redirected to the redirect_uri with following parameters set to summarize the error:

Error codes
invalid_client_id	Occurs if the client_id parameter provided with the request was invalid
invalid_scope	Occurs if the scope parameter provided with the request was invalid

Exchange your authorization code for access credentials

To request access credentials, execute a POST request to the Token URL below with your authorization code.

Note: the authorization code is valid for 5 minutes. If you do not request your access token before the authorization code expires, you will need to repeat step 1.

Token URL: https://www.myworkboard.com/wb/oauth/token

Parameters
client_id	The client id you received when you registered your app (Required)
client_hash	The client hash you received when you registered your app (Required)
code	The authorization code you received in Step 1. (Required)
redirect_uri	The URL in your app to which WorkBoard will redirect after authorization (this URL must match the redirect URI that was used in registering your application)
state	A random string, used to protect against cross-site request forgery attacks. WorkBoard will redirect to the specified redirect_uri with the same value passed in the state parameter. If the two values don't match, the access call should be aborted. (Optional)

The access_token is valid for one year, and can be revoked with https://www.myworkboard.com/wb/oauth/revoke/

Using access_token in your API requests

Every request to the API should be made via HTTPS and must include your access_token, which must be passed in the authorization header.