Skip to main content

Workflowmax

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable PyAirbyte
Connector type (beta)
Available Data replicationNot available Agent(learn more)
Support Level
Marketplace
Connector Version
0.0.68 (last updated 2 days ago)
Data workers used
0.2 per sync (Learn more)
Definition ID
a3eb6410-f3c3-48ba-8b27-29a56de1e9db

This directory contains the manifest-only connector for source-workflowmax.

Documentation reference:​

Visit https://app.swaggerhub.com/apis-docs/WorkflowMax-BlueRock/WorkflowMax-BlueRock-OpenAPI3/0.1#/ for V1 API documentation

Authentication setup​

WorkflowMax uses OAuth 2.0. Access tokens expire after 30 minutes and refresh tokens expire after 60 days (see the WorkflowMax authentication docs), so the connector needs your OAuth application's Client ID, Client Secret and a Refresh Token in order to obtain new access tokens automatically. A static access token alone will stop working within 30 minutes.

Using postman to get a refresh token​

  • Register an OAuth 2.0 application in the WorkflowMax developer portal and note the Client ID and Client Secret.
  • Move to Authorization tab of an empty http request and selected Oauth 2.0
  • Set use token type as access token
  • Set header prefix as Bearer
  • Set grant type as Authorization code
  • Check Authorize using browser
  • Set Auth URL as https://oauth.workflowmax2.com/oauth/authorize
  • Set Access token URL as https://oauth.workflowmax2.com/oauth/token
  • Set Client ID, Client secret, Scope defined as your Workflowmax settings. The scope must include offline_access to receive a refresh token, Example Scope: openid profile email workflowmax offline_access
  • Set state as any number, Example: 1
  • Set Client Authentication as Send as Basic Auth Header Click Get New Access Token; copy the refresh_token (and optionally the access_token) from the response.

Then authorize your source with the required information.

  1. Go to set up The Source page.
  2. Enter your Workflowmax application's Client ID, Client Secret and Refresh Token (the Access Token field is optional).
  3. Enter your Account ID and Start date.
  4. Click Save button.

Configuration​

InputTypeDescriptionDefault Value
client_idstringClient ID. The Client ID of your WorkflowMax OAuth 2.0 application.
client_secretstringClient Secret. The Client Secret of your WorkflowMax OAuth 2.0 application.
refresh_tokenstringRefresh Token. OAuth 2.0 refresh token obtained with the offline_access scope; used to refresh the access token automatically.
api_key_2stringAccess Token. Optional - refreshed and stored automatically.
account_idstringAccount ID. The account id for workflowmax
start_datestringStart date.

Streams​

Stream NamePrimary KeyPaginationSupports Full SyncSupports Incremental
stafflistUUIDDefaultPaginator✅❌
clientlistUUIDDefaultPaginator✅❌
clients_documentsuuidNo pagination✅❌
clientgrouplistUUIDDefaultPaginator✅❌
costlistUUIDDefaultPaginator✅❌
invoice_currentUUIDDefaultPaginator✅❌
invoicelistUUIDDefaultPaginator✅✅
joblistUUIDDefaultPaginator✅✅
job_tasksUUIDDefaultPaginator✅✅
leadlistUUIDDefaultPaginator✅✅
purchaseorderlistIDDefaultPaginator✅✅
tasklistUUIDDefaultPaginator✅❌
quotelistUUIDDefaultPaginator✅✅
supplierlistUUIDDefaultPaginator✅❌
timelistUUIDDefaultPaginator✅✅

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
string
account_id
string
start_date
string
api_key_2
string
client_id
string
client_secret
string
refresh_token
string
token_expiry_date

Changelog​

Expand to review
VersionDatePull RequestSubject
0.0.682026-10-1388883Update dependencies
0.0.672026-10-0788239Fix authentication: refresh the OAuth access token automatically (WorkflowMax access tokens expire after 30 minutes); use the documented pagesize query parameter
0.0.662026-10-0688119Update dependencies
0.0.652026-09-2987410Update dependencies
0.0.642026-09-2286894Update dependencies
0.0.632026-09-1586285Update dependencies
0.0.622026-09-0885718Update dependencies
0.0.612026-08-1884812Update dependencies
0.0.602026-08-1184193Update dependencies
0.0.592026-08-0483686Update dependencies
0.0.582026-07-2883160Update dependencies
0.0.572026-07-2182652Update dependencies
0.0.562026-07-1482078Update dependencies
0.0.552026-06-3081314Update dependencies
0.0.542026-06-2380710Update dependencies
0.0.532026-06-1680109Update dependencies
0.0.522026-06-0979576Update dependencies
0.0.512026-06-0279088Update dependencies
0.0.502026-04-2877494Update dependencies
0.0.492026-04-2176831Update dependencies
0.0.482026-03-3175862Update dependencies
0.0.472026-03-1775093Update dependencies
0.0.462026-03-0373913Update dependencies
0.0.452026-02-1773530Update dependencies
0.0.442026-02-1072678Update dependencies
0.0.432026-01-2072051Update dependencies
0.0.422026-01-1471459Update dependencies
0.0.412025-12-1870680Update dependencies
0.0.402025-11-2570185Update dependencies
0.0.392025-11-1869638Update dependencies
0.0.382025-10-2968976Update dependencies
0.0.372025-10-2168346Update dependencies
0.0.362025-10-1467955Update dependencies
0.0.352025-10-0767332Update dependencies
0.0.342025-09-3066446Update dependencies
0.0.332025-09-0965691Update dependencies
0.0.322025-08-2465492Update dependencies
0.0.312025-08-1064857Update dependencies
0.0.302025-08-0264340Update dependencies
0.0.292025-07-2664079Update dependencies
0.0.282025-07-1963627Update dependencies
0.0.272025-07-1263226Update dependencies
0.0.262025-07-0562751Update dependencies
0.0.252025-06-2862268Update dependencies
0.0.242025-06-2161750Update dependencies
0.0.232025-06-1561212Update dependencies
0.0.222025-05-2460748Update dependencies
0.0.212025-05-1059972Update dependencies
0.0.202025-05-0459550Update dependencies
0.0.192025-04-2658938Update dependencies
0.0.182025-04-1958544Update dependencies
0.0.172025-04-1258027Update dependencies
0.0.162025-04-0557381Update dependencies
0.0.152025-03-2956876Update dependencies
0.0.142025-03-2256313Update dependencies
0.0.132025-03-0855583Update dependencies
0.0.122025-03-0155141Update dependencies
0.0.112025-02-2254523Update dependencies
0.0.102025-02-1553526Update dependencies
0.0.92025-02-0153070Update dependencies
0.0.82025-01-2552441Update dependencies
0.0.72025-01-1851947Update dependencies
0.0.62025-01-1151422Update dependencies
0.0.52024-12-2850782Update dependencies
0.0.42024-12-2150324Update dependencies
0.0.32024-12-1447888Update dependencies
0.0.22024-10-2847527Update dependencies
0.0.12024-10-1346866Initial release by @btkcodedev via Connector Builder
Was this page helpful?