Skip to Content

monday.com Connection Details

Introduction

Connector Version

This documentation is based on version 22.0.8676 of the connector.

Get Started

Monday Version Support

The connector leverages the Monday API to enable bidirectional access to Monday.

Establish a Connection

Connect to Monday GraphQL API

Connect using either API Token authentication or OAuth authentication

Connect with an API Token

Connect to connector by specifying the APIToken. Set the AuthScheme to Token and obtain APIToken as follows:

  1. Log in to your Monday account and navigate to Manage Applications in the left pane.
  2. Select the application that you would like to create a token for. You may need to create an application first.
  3. Click the Create token button to generate an APIToken.
OAuth

Alternatively, you can establish a connection Using OAuth Authentication.

Connect to Monday AuditLog API

To generate the audit log API token, access the admin section of your Monday account, click into the "Security" section and then the "Audit" tab. From there, select on the "Monitor by API" button and copy it.

After retrieving the API token you can connect from the driver by setting the following conenction properties:

  • Schema=AuditLog
  • AuthScheme=Token
  • APIToken=Your audit log API token
  • **Domain**=https://yourdomain.monday.com

Use OAuth Authentication

OAuth requires the authenticating user to interact with Monday using the browser. The connector facilitates this in various ways as described below.

Custom Credentials

You need to register an app to obtain the OAuthClientId and OAuthClientSecret.

Desktop Applications

Create an OAuth app. See Creating a Custom OAuth App for the procedure.

Create a Custom OAuth App

See Creating a Custom OAuth App for the procedure.

Custom Credentials

This section describes desktop authentication using the credentials for your custom OAuth app. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

After setting the following, you are ready to connect:

  • AuthScheme: Set to OAuth.
  • OAuthClientId: Set to the Client ID in your app settings.
  • OAuthClientSecret: Set to the Client Secret in your app settings.
  • CallbackURL: Set to the Redirect URL in your app settings.
  • InitiateOAuth: Set to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the following OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Headless Machines

To create Monday data sources on headless servers or other machines on which the connector cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.

  1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the connector's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Use the Credentials for a Custom OAuth App
Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure. This section describes the procedure to authenticate and connect to data.

Obtain a Verifier Code

First, set the following properties on the headless machine:

  • InitiateOAuth: Set to OFF.
  • OAuthClientId: Set to the App ID in your app settings.
  • OAuthClientSecret: Set to the App Secret in your app settings.

Next, authenticate from another machine and obtain the OAuthVerifier connection property:

  1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
  2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You need to set this in the OAuthVerifier connection property.

Finally, on the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • AuthScheme: Set to OAuth.
  • OAuthClientId: Set to the consumer key in your app settings.
  • OAuthClientSecret: Set to the consumer secret in your app settings.
  • OAuthVerifier: Set to the verifier code.
  • OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified file.
  • InitiateOAuth: Set to REFRESH.
Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set to REFRESH.
Transfer OAuth Settings

To install the connector on another machine, authenticate, and then transfer the resulting OAuth values:

  1. On a second machine, install the connector and connect with the following properties set:
    • OAuthSettingsLocation: Set to a writable text file.
    • InitiateOAuth: Set to GETANDREFRESH.
    • AuthScheme: Set to OAuth.
    • OAuthClientId: Set to the Client ID in your app settings.
    • OAuthClientSecret: Set to the Client Secret in your app settings.
    • CallbackURL: Set to the Callback URL in your app settings.
  2. Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
    • InitiateOAuth: Set to REFRESH.
    • OAuthSettingsLocation: Set to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Create a Custom OAuth App

Create a Custom OAuth App: Desktop

Complete the following procedure to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL.

GraphQL Limitations

Every GraphQL API has its own limitations and we can not query an arbitrarily large number of nodes because every query has a cost and the API will return an error if the connector exceeds the maximum cost. The query cost function is directly dependent on the page sizes. The connector uses its own algorithms for finding the page sizes but also gives you the freedom to tweak them based on your needs. There are two ways you can achieve this behavior:

  • Specify custom page size weights by including the "other:pageSizeWeights" attribute. Let's suppose that we have a "Customers" table which has two nested GraphQl connections, businesses and customers. If you want a specific ratio between these two entities per query, let's say 200 customers per 1 business, you should specify "other:pageSizeWeights=1:200" in the respective script. The advantage of this attribute is that you do not bypass our logic for finding the optimal page size based on the query cost.
  • Specify custom page sizes by including the "other:pageSizes" attribute. By specifying this attribute you will bypass any check we do for query cost, so you should be careful because there will be API errors if you exceed the maximum cost per query. Example: "other:pageSizeWeights=10,30", retrieve at most 10 businesses and at most 30 customers per business in one query.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Monday connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Monday and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Jitterbit Connector for Monday allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

The Jitterbit Connector for Monday models Monday objects as relational tables and views. An Monday object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Monday APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

The connector offloads as much of the SELECT statement processing as possible to the Monday APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Using GraphQL API

See GraphQL Data Model for the available entities in the GraphQL API.

Using AuditLog API

See AuditLog Data Model for the available entities in the AuditLog API.

GraphQL Data Model

Overview

The Jitterbit Connector for Monday models Monday objects as relational tables and views.

A Monday object has relationships to other objects in the tables. These relationships are expressed through foreign keys. The following sections show the available API objects and provide more information regarding executing SQL to Monday APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Views

Views describes the available views. Views are statically defined to model Accounts, Customers, Products, and more.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Jitterbit Connector for Monday Views
Name Description
ActivityLogs The board log events.
Assets Get a collection of assets by ids.
BoardItemsInternal Get a collection of board and item IDs. This view is for internal usage only.
Boards Get a collection of boards.
BoardViews The board's views.
Columns The board's visible columns.
ColumnValues The item's column values.
Groups The board's visible groups.
Items Get a collection of items.
Tags Get a collection of tags.
Teams Get a collection of teams.
Updates Get a collection of updates.
Users Get a collection of users.
ActivityLogs

The board log events.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

  • BoardId supports the '=, IN' operators.
  • UserId supports the '=, IN' operators.
  • ColumnId supports the '=, IN' operators.
  • GroupId supports the '=, IN' operators.
  • ItemId supports the '=, IN' operators.
  • CreatedAt supports the '=, >, >=, <, <=' operators.

SELECT

SELECT * FROM ActivityLogs WHERE BoardId IN ('2307103055','2182296646')
SELECT * FROM ActivityLogs WHERE UserId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE ColumnId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE GroupId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE ItemId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE CreatedAt > '2022-02-17 05:12:04.419' AND CreatedAt < '2022-02-17 05:12:04.861'

SELECT * FROM ActivityLogs WHERE CreatedAt >= '2022-02-17 05:12:04.419' AND CreatedAt <= '2022-02-17 05:12:04.861'
Columns
Name Type References Description
Id [KEY] String The ID of the activity log event.
BoardId Long Boards.id The unique identifier of the board.
AccountId String The account ID that initiated the event.
UserId Int Users.Id The user ID of the user who initiated the event.
CreatedAt Datetime The time of the event.
Data String The item's column values in string form.
Entity String The entity of the event that was changed (pulse / board).
Event String The action that took place.
ColumnId String Column ID to filter.
GroupId String Group ID to filter.
ItemId Long Item ID to filter.
Assets

Get a collection of assets by ids.

Table Specific Information

Note

The ID filter is required to retrieve data from this table.

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

  • Id supports the '=, IN' operators.

SELECT

SELECT * FROM Assets WHERE Id = '397532775'

SELECT * FROM Assets WHERE ID IN ('397532775','397532776')
Columns
Name Type References Description
Id [KEY] Int The file's unique identifier.
Name String The file's name.
CreatedAt Datetime The file's creation date.
FileExtension String The file's extension.
FileSize Int The file's size in bytes.
OriginalGeometry String The original geometry of the asset.
PublicUrl String The public URL to the asset, valid for 1 hour.
UploadedById Int Users.Id The user's unique identifier.
Url String The URL to view the asset.
UrlThumbnail String The URL to view the asset in thumbnail mode. Only available for images.
BoardItemsInternal

Get a collection of board and item IDs. This view is for internal usage only.

Columns
Name Type References Description
BoardId [KEY] Long The unique identifier of the board.
ItemId [KEY] Long The item's unique identifier.
Boards

Get a collection of boards.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

  • Id supports the '=, IN' operators.
  • BoardKind supports the '=' operators.

SELECT

SELECT * FROM Boards WHERE Id = '2182296646'
SELECT * FROM Boards WHERE Id IN ('2307103055','2182296646','2181960030')
SELECT * FROM Boards WHERE Id IN ('2307103055','2182296646','2181960030') AND BoardKind = 'public'

SELECT * FROM Boards WHERE BoardKind = 'public'
Columns
Name Type References Description
Id [KEY] Long The unique identifier of the board.
TopGroupId String Groups.Id The group's unique identifier.
Name String The board's name.
ItemsCount Int The number of items on the board.
Description String The board's description.
UpdatedAt Datetime The last time the board was updated at.
BoardKind String The board's kind (public / private / share).
BoardFolderId Int The board's folder unique identifier.
Communication String Get the board communication value - typically meeting ID.
Permissions String The board's permissions.
Pos String The board's position.
TagsIds String A comma separated list of the tags' unique identifiers.
State String The board's state (all / active / archived / deleted).
WorkspaceId Int The board's workspace unique identifier (null for main workspace).
WorkspaceName String The board's workspace name.
WorkspaceKind String Will return Open for Open Workspaces, and Closed for Closed Workspaces.
WorkspaceDescription String The board's workspace description.
BoardViews

The board's views.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

  • BoardId supports the '=, IN' operators.
  • Type supports the = operator.

SELECT

SELECT * FROM BoardViews WHERE BoardId = '2182296646'
SELECT * FROM BoardViews WHERE Type = 'Chart'

SELECT * FROM BoardViews WHERE BoardId IN ('2182296646','2181960030')
Columns
Name Type References Description
Id [KEY] String The view's unique identifier.
BoardId Long Boards.Id The unique identifier of the board.
Name String The view's name.
Settings String The view's settings in a string form.
Type String The view's type.
Columns

The board's visible columns.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

  • ID supports the '=, IN' operators.
  • BoardId supports the '=, IN' operators.

SELECT

SELECT * FROM Columns WHERE ID = 'name'
SELECT * FROM Columns WHERE ID IN ('name','person')
SELECT * FROM Columns WHERE BoardId = '2182296646'

SELECT * FROM Columns BoardId IN ('2182296646','2181960030')
Columns
Name Type References Description
Id [KEY] String The column's identifier, unique only to its board.
BoardId [KEY] Long Boards.id The unique identifier of the board.
Archived Bool Whether or not the column is archived.
Settings String The column's settings in a string form.
Title String The column's title.
Type String The column's type.
Width Int The column's width.
ColumnValues

The item's column values.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

  • Id supports the '=, IN' operators.
  • ItemId supports the '=, IN' operators.

SELECT

SELECT * FROM ColumnValues WHERE Id = 'person'
SELECT * FROM ColumnValues WHERE Id IN ('person','status')
SELECT * FROM ColumnValues WHERE ItemId IN ('2181853162','2181853151')
SELECT * FROM ColumnValues WHERE ItemId = '2181853162'

SELECT * FROM ColumnValues WHERE ItemId = '2181853162' AND ID = 'status'
Columns
Name Type References Description
Id [KEY] String The column's unique identifier.
ItemId [KEY] Long Items.Id The item's unique identifier.
AdditionalInfo String The column value's additional information.
Text String The column's textual value in string form.
Title String The column's title.
Type String The column's type.
Value String The column's value in json format.
Groups

The board's visible groups.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

  • Id supports the '=, IN' operators.
  • BoardId supports the '=, IN' operators.

SELECT

SELECT * FROM Groups WHERE Id = 'topics'
SELECT * FROM Groups WHERE Id IN ('topics','group_title')
SELECT * FROM Groups WHERE BoardId IN ('2182296646','21822966')

SELECT * FROM Groups WHERE BoardId = '2182296646' AND ID = 'topics'
Columns
Name Type References Description
Id [KEY] String The group's unique identifier.
BoardId [KEY] Long Boards.Id The unique identifier of the board.
Archived Bool Whether or not the group is archived.
Color String The group's color.
Deleted Bool Whether or not the group is deleted.
Position String The group's position in the board.
Title String The group's title.
Items

Get a collection of items.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

  • Id supports the '=' operators.
  • BoardId supports the '=' operators.
  • ColumnId supports the '=' operators.
  • ColumnValue supports the '=, IN' operators.

SELECT

SELECT * FROM Items ORDER BY CreatedAt DESC
SELECT * FROM Items WHERE Id = 2181917692
SELECT * FROM Items WHERE BoardId = '2181917679' AND ColumnId = 'text' AND ColumnValue = 'test'

SELECT * FROM Items WHERE BoardId = '2181917679' AND ColumnId = 'text' AND ColumnValue IN ('Working on it','test')
Columns
Name Type References Description
Id [KEY] Long The item's unique identifier.
BoardId Long Boards.Id The unique identifier of the board.
CreatorId String Users.Id The unique identifier of the item creator.
GroupId String Groups.Id The group's unique identifier.
CreatedAt Datetime The item's create date.
Name String The item's name.
Email String The item's email.
State String The item's state (all / active / archived / deleted).
UpdatedAt Datetime The item's last update date.
AssetsIds String A comma separated list of the items' assets/files unique identifiers.
ColumnId String Columns.Id The column's unique identifier.
ColumnValue String The column values to search items by. You can use text values for the search.
ColumnType String The column type.
Tags

Get a collection of tags.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

  • ID supports the '=, IN' operators.
  • IsPrivate supports the = operator.

SELECT

SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE IsPrivate = false
SELECT * FROM Tags WHERE ID = '13327214'

SELECT * FROM Tags WHERE ID IN ('13327214','13327217')
Columns
Name Type References Description
Id [KEY] Int The tag's unique identifier.
Color String The tag's color.
Name String The tag's name.
IsPrivate Bool Whether or not the tag is private. The default value is false.
Teams

Get a collection of teams.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

  • Id supports the '=, IN' operators.

SELECT

SELECT * FROM Teams WHERE Id = '565332'

SELECT * FROM Teams WHERE ID IN ('565332,565333')
Columns
Name Type References Description
Id [KEY] Int The team's unique identifier.
Name String The team's name.
PictureUrl String The team's picture URL.
Updates

Get a collection of updates.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Updates
Columns
Name Type References Description
Id [KEY] String The update's unique identifier.
Body String The update's html formatted body.
CreatedAt Datetime The update's creation date.
CreatorId String Users.Id The unique identifier of the update creator.
ItemId String The update's item ID.
TextBody String The update's text body.
UpdatedAt Date The update's last edit date.
AssetsIds String A comma separated list of the update's assets/files unique identifiers.
Replies String The update's replies.
Users

Get a collection of users.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

  • ID supports the '=, IN' operators.
  • IsPending supports the '=' operators.
  • IsGuest supports the '=' operators.
  • Email supports the '=, IN' operators.

SELECT

SELECT * FROM Users ORDER BY CreatedAt DESC
SELECT * FROM Users WHERE IsPending = true
SELECT * FROM Users WHERE IsGuest = true
SELECT * FROM Users WHERE ID = '27278379'
SELECT * FROM Users WHERE ID IN ('27278379','27278377')
SELECT * FROM Users WHERE Email = 'test@cdata.com'

SELECT * FROM Users WHERE Email IN ('test@cdata.com','test@gmail.com')
Columns
Name Type References Description
Id [KEY] Int The user's unique identifier.
TeamsIds String Teams.Id A list of teams unique identifiers to which the user belongs.
Name String The user's name.
Phone String The user's phone number.
Birthday Date The user's birthday.
CountryCode String The user's country code.
CreatedAt Datetime The user's creation date.
Email String The user's email.
Enabled Bool Whether or not the user is enabled.
EncryptApiToken String The token of the user for email to board.
IsAdmin Bool Whether or not the user is an account admin.
IsGuest Bool Whether or not the user is a guest.
IsPending Bool Whether or not the user is a pending user
IsVerified Bool Whether or not the user verified their email.
IsViewOnly Bool Whether or not the user is a view only user.
JoinDate Date The date the user joined the account.
Location String The user's location.
MobilePhone String The user's mobile phone number.
PhotoOriginal String The user's photo in the original size.
PhotoSmall String The user's photo in small size (150x150).
PhotoThumb String The user's photo in thumbnail size (100x100).
PhotoThumbSmall String The user's photo in small thumbnail size (50x50).
PhotoTiny String The user's photo in tiny size (30x30).
TimeZoneIdentifier String The user's timezone identifier.
Title String The user's title.
Url String The user's profile URL.
UtcHoursDiff Int The user's utc hours difference.
AccountFirstDayOfTheWeek String The first day of the week for the account (sunday / monday)
AccountId Int The account's unique identifier.
AccountLogo String The account's logo.
AccountName String The account's name.
AccountPlanMaxUsers Int The maximum users allowed in the plan.
AccountPlanPeriod String The plan's time period.
AccountPlanTier String The plan's tier.
AccountPlanVersion Int The plan's version.
AccountShowTimelineWeekends Bool Whether or not to show weekends in the timeline.
AccountSlug String The account's slug.
AccountTier String The account's tier.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Monday.

Stored procedures accept a list of parameters, perform their intended function, and then return, if applicable, any relevant response data from Monday, along with an indication of whether the procedure succeeded or failed.

Jitterbit Connector for Monday Stored Procedures
Name Description
GetOAuthAccessToken Gets the OAuth access token from GitHub.
GetOAuthAuthorizationURL Gets the GitHub authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to GitHub.
GetOAuthAccessToken

Gets the OAuth access token from GitHub.

Input
Name Type Required Description
AuthMode String False The type of authentication mode to use. The allowed values are APP, WEB.
Verifier String False The verifier token returned by GitHub after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode.
Scope String False The scope or permissions you are requesting. The default value is boards:read workspaces:read users:read account:read updates:read assets:read tags:read teams:read.
CallbackUrl String False The URL the user will be redirected to after authorizing your application.
State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to GitHub authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from GitHub.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime for the access token in seconds.
GetOAuthAuthorizationURL

Gets the GitHub authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to GitHub.

Input
Name Type Required Description
CallbackUrl String False The URL that GitHub will return to after the user has authorized your app.
Scope String False The scope or permissions you are requesting. The default value is boards:read workspaces:read users:read account:read updates:read assets:read tags:read teams:read.
State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to GitHub authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
URL String The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with.

AuditLog Data Model

Overview

The Jitterbit Connector for Monday models Monday objects as relational tables and views.

A Monday object has relationships to other objects in the tables. These relationships are expressed through foreign keys. The following sections show the available API objects and provide more information regarding executing SQL to Monday APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Views

Views describes the available views. Views are statically defined to model AuditLogs.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Jitterbit Connector for Monday Views
Name Description
AuditLogs The board audit log events.
AuditLogs

The board audit log events.

Table Specific Information

The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.

For example, the following queries are processed server side.

  • Timestamp supports the '=, >, >=, <, <=' operators.
  • UserId supports the = operator.
  • IpAddress supports the = operator.
  • Event supports the '=, IN' operators.

All available values for the event filter are listed and explained below:

  • export-board-activity-log: Logs board Activity Log export by users
  • export-account-data: Logs account data export by admins
  • download-attachment: Logs file downloads by users
  • export-board: Logs board exports by users
  • export-dashboard: Logs dashboard exports by users
  • export-content-directory: Logs content directory exports by admins
  • login: Logs users' logins to the system
  • forgot-password: Logs users' "Forgot password?" clicks from the login page
  • logout: Logs users' logouts from the system
  • failed-login: Logs users' failed login attemts
  • user-reactivated: Logs users' reactivation by admins
  • user-deactivated: Logs users' deactivation by admins
  • user-details-deleted: Logs users' deletion by admins
  • user-invite: Logs users' invite from within the system
  • cancel-user-invite: Logs cancelled users' invite from within the system
  • user-role-change: Logs users' type change by admins
  • delete-board: Logs board deletion by users
  • delete-workspace: Logs workspace deletion by users
  • create-team: Logs team creation by users
  • delete-team: Logs team deletion by users
  • security-settings-change: Logs security settings changes by admins
  • board-broadcast-enabled: Logs board broadcast enablement by users
  • add-user-to-team: Logs users' addition to teams by users
  • remove-user-from-team: Logs users' removal from teams by users
  • add-user-to-product: Logs users' addition to Work OS Products
  • remove-user-from-product: Logs users' removal from Work OS Products
  • add-team-to-product: Logs teams' addition to Work OS Products
  • remove-team-from-product: Logs teams' removal from Work OS Products
  • api-complexity-breach-over-time: Logs api calls reaching the account limit

SELECT

The following queries are executed server-side:

SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z'
SELECT * FROM AuditLogs WHERE Event IN ('export-board-activity-log', 'delete-board')
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z' AND Event = 'delete-board' AND UserId = 27 AND IpAddress = '123.123'
Columns
Name Type References Description
Timestamp Datetime The timestamp of the event
AccountId String The account ID that initiated the event.
UserId Integer The user ID of the user who initiated the event.
Event String The action that took place. The allowed values are export-board-activity-log, export-account-data, download-attachment, export-board, export-dashboard, export-content-directory, login, forgot-password, logout, failed-login, user-reactivated, user-deactivated, user-details-deleted, user-invite, cancel-user-invite, user-role-change, delete-board, delete-workspace, create-team, delete-team, security-settings-change, board-broadcast-enabled, add-user-to-team, remove-user-from-team, add-user-to-product, remove-user-from-product, add-team-to-product, remove-team-from-product, api-complexity-breach-over-time.
Slug String The slug of the event that took place.
IpAddress String The IP Address recorded for this event.
UserAgent String The User Agent of the event.
ClientName String Name of the software client.
ClientVersion String Version of the software client.
OsName String Name of the operating system.
OsVersion String Version of the operating system.
DeviceName String The name of the device.
DeviceType String The type of the device.
ActivityMetadata String Additional activity metadata for the event

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Monday:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Invoices table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Invoices'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Invoices table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Invoices'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:monday:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Property Description
Schema Specifies which Monday API to use.
AuthScheme The type of authentication to use when connecting to Monday.
APIToken The API token obtained from your Monday account.
Domain Specify the domain of your Monday account. Required only when using AuditLog schema. Example: https://yourdomain.monday.com.

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
MaxPointsPerCall Specifies how many points a call will cost.
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

Authentication

This section provides a complete list of authentication properties you can configure.

Property Description
Schema Specifies which Monday API to use.
AuthScheme The type of authentication to use when connecting to Monday.
APIToken The API token obtained from your Monday account.
Domain Specify the domain of your Monday account. Required only when using AuditLog schema. Example: https://yourdomain.monday.com.

Schema

Specifies which Monday API to use.

Possible Values

GraphQL, AuditLog

Data Type

string

Default Value

GraphQL

Remarks

The available values are GraphQL and AuditLog.

AuthScheme

The type of authentication to use when connecting to Monday.

Possible Values

Token, OAuth

Data Type

string

Default Value

Token

Remarks
  • Token: Set this to perform Monday token authentication.
  • OAuth: Set this to perform Monday OAuth authentication.

APIToken

The API token obtained from your Monday account.

Data Type

string

Default Value

""

Remarks

Admin Tab

If you are an admin user on your monday.com account, you are able to access your API tokens from the "Admin" tab with the following steps:

  1. Log into your monday.com account.
  2. Click on your avatar (picture icon) in the bottom left corner of your screen.
  3. Select Admin from the resulting menu (this requires you to have admin permissions).
  4. Go to the API section.
  5. Generate a "API v2 Token"
  6. Copy your token.

Developer Tab

If you are a member user on your monday.com account, you are able to access your API tokens from the Developer tab with the following steps:

  1. Log into your monday.com account.
  2. Click on your avatar (picture icon) in the bottom left corner of your screen.
  3. Select Developer from the resulting menu.
  4. In the top menu, click on the "Developer" dropdown menu.
  5. Select the first option on the dropdown menu titled "My Access Tokens."
  6. Click on the blue "Show" button to expose your API token and copy it.

Domain

Specify the domain of your Monday account. Required only when using AuditLog schema. Example: https://yourdomain.monday.com.

Data Type

string

Default Value

""

Remarks

Specify the domain of your Monday account. Required only when using AuditLog schema. Example: https://yourdomain.monday.com

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.

Data Type

string

Default Value

%APPDATA%\Monday Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\Monday Data Provider\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

CallbackURL

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\Monday Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\Monday Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
MaxPointsPerCall Specifies how many points a call will cost.
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

MaxPointsPerCall

Specifies how many points a call will cost.

Data Type

string

Default Value

1000000

Remarks

The total cost of your queries cannot exceed 5,000,000 points at any given time.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"