Monday

Use the Monday connector to perform insert, delete, update, and read operations on Monday.com.

Before you begin

Before using the Monday connector, do the following tasks:

In your Google Cloud project:
- Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
- Grant the roles/connectors.admin IAM role to the user configuring the connector.
- Grant the following IAM roles to the service account that you want to use for the connector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.
- Enable the following services:
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (Connectors API)
  To understand how to enable services, see Enabling services.
If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.
For information about how to get the API token for authentication, see API Token.
For information about authenticating Monday apps with OAuth 2.0, see OAuth 2.0.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.
Go to the Connections page
Click + Create new to open the Create Connection page.
In the Location section, choose the location for the connection.
1. Region: Select a location from the drop-down list.
  Supported regions for connectors include:
  For the list of all the supported regions, see Locations.
2. Click Next.
In the Connection Details section, complete the following:
1. Connector: Select Monday from the drop down list of available Connectors.
2. Connector version: Select the Connector version from the drop down list of available versions.
3. In the Connection Name field, enter a name for the Connection instance.
  Connection names must meet the following criteria:
  - Connection names can use letters, numbers, or hyphens.
  - Letters must be lower-case.
  - Connection names must begin with a letter and end with a letter or number.
  - Connection names cannot exceed 49 characters.
4. Optionally, enter a Description for the connection instance.
5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
6. Service Account: Select a service account that has the required roles.
7. Optionally, configure the Connection node settings:
  - Minimum number of nodes: Enter the minimum number of connection nodes.
  - Maximum number of nodes: Enter the maximum number of connection nodes.
  A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
8. Use proxy: Select this checkbox to configure a proxy server for the connection.
  - Proxy Auth Scheme: The authentication type to use to authenticate to the ProxyServer proxy.
  - Proxy User: A user name to be used to authenticate to the ProxyServer proxy.
  - Proxy Password: A password to be used to authenticate to the ProxyServer proxy.
  - Proxy SSL Type: The SSL type to use when connecting to the ProxyServer proxy.
9. Optionally, click + Add label to add a label to the Connection in the form of a key/value pair.
10. Click Next.
In the Destinations section, enter details of the remote host (backend system) you want to connect to.
1. Destination Type: You can specify the destination details either as a host address or a service attachment. Select any of the following destination types:
  - Host address: If you want to specify the hostname or IP address of the destination.
  - Service attachment: If you want to specify the private endpoint for your internal IP addresses. The service attachment, lets you hide your internal IP addresses from the external network. You can create a service attachment in Google Cloud, by using the Private Service Connect feature. For information on configuring a Private Service Connect, see Publish managed services.
  Based on your selection of destination type, enter the host address or the service attachment name.
  
  To enter additional destinations, click +Add destination.
2. Click Next.
In the Authentication section, enter the authentication details.
1. Select an Authentication type and enter the relevant details.
  The following authentication types are supported by the Monday connection:
  - OAuth 2.0
  - API Token
2. Click Next.
Review: Review your connection and authentication details.
Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

OAuth 2.0
- Client ID: The client ID used for requesting access tokens.
- Client secret: The client secret used for requesting access tokens.
- OAuth Access token: The access token used for authenticating requests with auth-code-flow-based connections.

API Token
If you want to use anonymous login, select Not Available.
- API Token: The API token obtained from your Monday account.

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

API token connection type

Field name	Details
Location	europe-west1
Connector	Monday
Connector version	1
Connection Name	monday-new-connector
Enable Cloud Logging	Yes
Log Level	Debug
Service Account	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Minimum number of nodes	2
Maximum number of nodes	50
Destination Type	Host Address
Host 1	https://your-domain.monday.com/
Authentication	Yes
API Token	API_TOKEN
Secret version	1 The resource name of the secret version has the following format: projects/PROJECT_NUMBER/secrets/CONNECTOR/versions/1

OAuth 2.0 connection type

Field name	Details
Location	europe-west1
Connector	Monday
Connector version	1
Connection Name	monday-oauth-conn
Enable Cloud Logging	Yes
Log Level	Error
Service Account	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Minimum number of nodes	2
Maximum number of nodes	50
Destination Type	Host Address
Host 1	https://your-domain.monday.com/
Authentication	Yes
Client ID	CLIENT_ID
Client Secret	CLIENT_SECRET
Secret version	1 The resource name of the secret version has the following format: projects/PROJECT_NUMBER/secrets/CONNECTOR/versions/1
Scope	account:read, users:read, assets:read, boards:read, boards:write, docs:read, docs:write, me:read, notifications:write, tags:read, teams:read, updates:read, updates:write, users:read, users:write, workspaces:read, workspaces:write

System limitations

The Monday connector can process a maximum of 1 query per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Note: The number of Integration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
If you are a subscription based customer, contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Use the Monday connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.
However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.
Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
- List
- Get
- Create
- Update
- Delete
Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.
Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This section lists the actions supported by the Monday connector. To understand how to configure the actions, see Action examples.

CreateNotification action

This action creates a new notification.

Input parameters of the CreateNotification action

Parameter name	Data type	Required	Description
UserId	String	Yes	The users unique identifier
TargetType	String	Yes	The targets type(Project/Post).
TargetId	String	Yes	The targets unique identifier
Text	String	Yes	The notification text

For example on how to configure the CreateNotification action, see Examples.

MoveItemToBoard action

This action moves or transfers the boards/files from one instance to another.

Input parameters of the MoveItemToBoard action

Parameter name	Data type	Required	Description
BoardId	String	Yes	The unique identifier of target board.
GroupId	String	Yes	The unique identifier of target group.
ItemId	String	Yes	The unique identifier of the item to move.

For example on how to configure the MoveItemToBoard action, see Examples.

DuplicateItem action

This action duplicates an existing item.

Input parameters of the DuplicateItem action

Parameter name	Data type	Required	Description
ItemId	String	Yes	The unique identifier of the item.
BoardId	String	Yes	The unique identifier of the board.
WithUpdates	Boolean	Yes	Duplicate with the item updates.

For example on how to configure the DuplicateItem action, see Examples.

LikeUpdate action

This action enables you to like a post.

Input parameters of the LikeUpdate action

Parameter name	Data type	Required	Description
UpdateId	String	Yes	The update identifier

For example on how to configure the LikeUpdate action, see Examples.

AddFileToColumn action

This action adds a file to a column.

Input parameters of the AddFileToColumn action

Parameter name	Data type	Required	Description
ItemId	String	Yes	The unique identifier of the item.
ColumnId	String	Yes	The unique identifier of the column.
Content	String	Yes	String content to upload a file.

For example on how to configure the AddFileToColumn action, see Examples.

AddFileToUpdate action

This action adds a file to update.

Input parameters of the AddFileToUpdate action

Parameter name	Data type	Required	Description
UpdateId	String	Yes	The update identifier
Content	String	Yes	String content to upload a file.

For example on how to configure the AddFileToUpdate action, see Examples.

DuplicateBoard action

This action duplicates data for a particular action.

Input parameters of the DuplicateBoard action

Parameter name	Data type	Required	Description
BoardId	String	Yes	The unique identifier of the board
DuplicateType	String	Yes	The duplication type.

For example on how to configure the DuplicateBoard action, see Examples.

DuplicateGroup action

This action duplicates data for a group.

Input parameters of the DuplicateGroup action

Parameter name	Data type	Required	Description
BoardId	String	Yes	The unique identifier of the board
GroupId	String	Yes	The unique identifier of Group.
AddToTop	Boolean	Yes	Indicates whether the new group is added to the top.
GroupTitle	String	Yes	The group title.

For example on how to configure the DuplicateGroup action, see Examples.

Action Examples

This section describes how to perform some of the actions in this connector.

Example - CreateNotification

In the Configure connector task dialog, click Actions.
Select the CreateNotification action, and then click Done.

In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

    {
      "UserId": "64384966",
      "TargetType": "Project",
      "TargetId": "1899350039",
      "Text": "This is notification from google Cloud."
    }

If the action is successful, the CreateNotification task's connectorOutputPayload response parameter will have a value similar to the following:

    [{
      "notificationid": "-1"
    }]

Example - MoveItemToBoard

In the Configure connector task dialog, click Actions.
Select the MoveItemToBoard action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
    {
      "BoardId": "1900739644",
      "GroupId": "topics",
      "ItemId": "1901835960"
    }
    
```

If the action is successful, the MoveItemToBoard task's connectorOutputPayload response parameter will have a value similar to the following:

  
    [{
      "itemid": "1901835960"
    }]

Example - DuplicateItem

In the Configure connector task dialog, click Actions.
Select the DuplicateItem action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
 
  {
    "ItemId": "1901835811",
    "BoardId": "1899350039",
    "WithUpdates": true
  }
  
```

If the action is successful, the DuplicateItem task's connectorOutputPayload response parameter will have a value similar to the following:

  [{
    "itemid": "1901835960"
  }]

Example - LikeUpdate

In the Configure connector task dialog, click Actions.
Select the LikeUpdate action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
  {
    "UpdateId": "18397960"
  }
  
```

If the action is successful, the LikeUpdate task's connectorOutputPayload response parameter will have a value similar to the following:

  [{
    "updateid": "690939"
  }]

Example - AddFileToColumn

In the Configure connector task dialog, click Actions.
Select the AddFileToColumn action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
  {
    "ItemId": "1901866680",
    "ColumnId": "files",
    "Content": "HI Team"
  }
  
```

If the action is successful, the AddFileToColumn task's connectorOutputPayload response parameter will have a value similar to the following:

  [{
    "assetid": "13325557"
  }]

Example - AddFileToUpdate

In the Configure connector task dialog, click Actions.
Select the AddFileToUpdate action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
  {
    "UpdateId": "18397903",
    "Content": "Integration Testing File Updated."
  }
  
```

If the action is successful, the AddFileToUpdate task's connectorOutputPayload response parameter will have a value similar to the following:

  [{
    "assetid": "13325933"
  }]

Example - DuplicateGroup

In the Configure connector task dialog, click Actions.
Select the DuplicateGroup action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
  {
    "BoardId": "1899350039",
    "GroupId": "new_demo_group4869__1",
    "AddToTop": true,
    "GroupTitle": "Duplicate Group"
  }
```

If the action is successful, the DuplicateGroup task's connectorOutputPayload response parameter will have a value similar to the following:

  [{
    "assetid": "13325933"
  }]

Example - DuplicateBoard

In the Configure connector task dialog, click Actions.
Select the DuplicateBoard action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
  {
    "BoardId": "1900733069",
    "DuplicateType": "duplicate_board_with_structure"
  }
  
```

If the action is successful, the DuplicateBoard task's connectorOutputPayload response parameter will have a value similar to the following:

  [{
    "assetid": "13325933"
  }]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List operation for Workspaces

In the Configure connector task dialog, click Entities.
Select Workspaces from the Entity list.
Select the List operation, and then click Done.
Task Input section of the Connectors task, you can set the filterClause as per the customer requirement. You can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes (').

You can perform List operation on the following entities:

Folders, Boards, BoardViews, BoardUsers, BoardTeams, ActivityLogs, Webhook, Tags, GoogleTestingProject(Item), GoogleTestingProject(SubItem), Users, Doc, DocBlocks, Teams, MoveItemToBoard, Groups, Updates, WorkspaceTeams, WorkspaceUsers, TeamUsers, GoogleTestingProject(Formula), GoogleTestingProject(Button), GoogleTestingProject(CreationLogs), GoogleTestingProject(Time Tracking), GoogleTestingProject(Color Picker), GoogleTestingProject(Last Updated At), GoogleTestingProject(Vote), Columns

GoogleTestingProject entity is a dynamically exposed entity. Using this entity, you can perform CRUD operations on Items and any column type.

Example - Get a single record from Workspaces

In the Configure connector task dialog, click Entities.
Select Workspaces from the Entity list.
Select the Get operation, and then click Done.
Set the entity ID to "961430" which is the Key to be passed. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "961430" in the Input Value field and choose the EntityId as Local variable.

If your entity has a composite primary key, you can specify a filter clause.

You can perform Get operation on the following entities:

Boards, BoardViews, ActivityLogs, WebHook, Tags, GoogleTestingProject(Item), GoogleTestingProject(SubItem), Asset, Users, Doc, DocBlock, Team, Updates, GoogleTestingProject(ConnectBoard), GoogleTestingProject(Mirror), Columns

Example - Delete a record from the entity Workspaces

In the Configure connector task dialog, click Entities.
Select Workspaces from the Entity list.
Select the Delete operation, and then click Done.
Set the entity ID to "961430" which is the Key to be passed.To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "961430" in the Input Value field and choose the EntityId as Local variable.
Alternately, if the entity has two composite business or primary keys instead of specifying the entityId, you can also set the filterClause to id='961430'.

You can perform Delete operation on the following entities:

Folders, Boards, WebHook, Groups, GoogleTestingProject(Item), SubItem, DocBlock, TeamUser, WorkspaceUser, Boards, BoardTeams, BoardUsers, Updates, Columns

Example - Create entity Workspace

In the Configure connector task dialog, click Entities.
Select Workspace from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "Name": "Riky's Workspace",
  "Kind": "open",
  "Description": "This is Riky's Workspace"
}
```
This example will create the Workspace. If the integration is successful, the Workspace task's connectorOutputPayload response parameter will have a value similar to the following:
```
 
{
  "Id": "964218"
}
```

Example - Create entity Workspaceuser (Single User)

In the Configure connector task dialog, click Entities.
Select Workspaceuser from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "WorkspaceId": "952743",
  "Kind": "subscriber",
  "Id": "'64427450'"
}
```
This example demonstrates how to add a single user in a Workspace and if the integration is successful, the Workspaceuser task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Success": true
}
```

Example - Create entity Workspaceuser (Multiple Users)

In the Configure connector task dialog, click Entities.
Select Workspaceuser from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "WorkspaceId": "1027130",
  "Kind": "subscriber",
  "Id": "64427450,64426103,65189599"
}
```
This example demonstrates how to add multiple users in a workspace. If the integration is successful, the Workspaceuser task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "64426103",
  "WorkspaceId": "1027130"
}
```

Example - Create entity WorkspaceTeams (Single Team)

In the Configure connector task dialog, click Entities.
Select WorkspaceTeams from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "WorkspaceId": "1027130",
  "Kind": "subscriber",
  "Id": "16516"
}
```
This example demonstrates how to add a single team in a workspace. If the integration is successful, the WorkspaceTeams task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "16516",
  "WorkspaceId": "1027130"
}
```

Example - Create entity WorkspaceTeams (Multiple Teams)

In the Configure connector task dialog, click Entities.
Select WorkspaceTeams from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "WorkspaceId": "1027130",
  "Kind": "subscriber",
  "Id": "16516,15056,14926"
}
```
This example demonstrates how to add multiple teams in a workspace. If the integration is successful, the WorkspaceTeams task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "16516",
  "WorkspaceId": "1027130"
}
```

Example - Create entity TeamUser (Single User)

In the Configure connector task dialog, click Entities.
Select TeamUser from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "TeamId": "15056",
  "Id": "64427450"
}
```
This example demonstrates how to add a single user in a team and if the integration is successful, the TeamUser task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "64427450",
  "TeamId": 15056
}
```

Example - Create entity TeamUser (MultipleUsers)

In the Configure connector task dialog, click Entities.
Select TeamUser from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "TeamId": "16516",
  "Id": "64427450,64426103,65189599"
}
```
This example demonstrates how to add multiple users in a team and if the integration is successful, the TeamUser task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "64427450",
  "TeamId": "16516"
}
```

Example - Create entity Boards

In the Configure connector task dialog, click Entities.
Select Boards from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "Name": "New Demo Board",
  "BoardKind": "public"
}
```
This example will create the Boards. If the integration is successful, the Boards task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "1900733069"
}
```

Example - Create entity Boardusers (Single User)

In the Configure connector task dialog, click Entities.
Select Boardusers from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1900739644",
  "Id": "64385055",
  "Kind": "subscriber"
}
```
This example demonstrates how to add a single user to a board and if the integration is successful, the Boardusers task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "64385055",
  "BoardId": null
} 
```

Example - Create entity Boardusers (Multiple Users)

In the Configure connector task dialog, click Entities.
Select Boardusers from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1899350039",
  "Id": "64427450,64426103,65189599",
  "Kind": "subscriber"
}
```
This example demonstrates how to add multiple users to a board and if the integration is successful, the Boardusers task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
"Id": "64426103",
"BoardId": "1899350039"
}
```

Example - Create entity BoardTeam (Single Team)

In the Configure connector task dialog, click Entities.
Select BoardTeam from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1899350039",
  "Id": "14926",
  "Kind": "subscriber"
 }
```
This example demonstrates how to add a single team to a board. If the integration is successful, the BoardTeam task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "14926",
  "BoardId": null
}
```

Example - Create entity BoardTeam (Multiple Team)

In the Configure connector task dialog, click Entities.
Select BoardTeam from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
 {
  "BoardId": "1919494280",
  "Id": "16516,15056,14926",
  "Kind": "subscriber"
}
```
This example demonstrates how to add multiple teams to a board and if the integration is successful, the BoardTeam task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "16516",
  "BoardId": "1919494280"
} 
```

Example - Create entity Group

In the Configure connector task dialog, click Entities.
Select Group from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1899350039",
  "Title": "New Demo Group",
  "RelativeTo": "mohit group",
  "PositionRelativeMethod": "after_at",
  "Color": "#FFCB00"
}
```
This example will create the Group. If the integration is successful, the Group task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "new_demo_group29615__1",
  "BoardId": "1899350039"
}
```

Example - Create entity Columns

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "people",
  "Title": "PeopleInfo",
  "Id": "people1"
}
```
This example will create the Column and if the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
 {
  "Id": "people1",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Date)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "Title": "Date",
  "Type": "date",
  "BoardId": "1922602090",
  "Id": "date"
}
 
```
This example will create the Date column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "date",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Dropdown)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "dropdown",
  "Title": "Dropdown",
  "Id": "dropdown_1"
}
```
This example will create the Dropdown column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
 {
  "Id": "dropdown_1",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Email)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "email",
  "Title": "Mail",
  "Id": "mail_11"
}
```
This example will create the Email column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "mail_11",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(LongText)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "long_text",
  "Title": "Longtext",
  "Id": "longtext1"
}
```
This example will create the LongText column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "longtext1",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Number)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
 {
  "BoardId": "1922602090",
  "Type": "numbers",
  "Title": "Number",
  "Id": "number"
}
```
This example will create the Number column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "number",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Phone)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "phone",
  "Title": "PhoneNumber",
  "Id": "phone43"
}
```
This example will create the Phone column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "phone43",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Text)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "text",
  "Title": "Text",
  "Id": "text18"
}
```
This example will create the Text column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
 {
  "Id": "text18",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns (Dependency)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
 {
  "BoardId": "1922602090",
  "Type": "dependency",
  "Title": "Dependency",
  "Id": "dependency_1"
}
 
```
This example will create the Dependency column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "dependency_1",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns (People)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "people",
  "Title": "PeopleInfo",
  "Id": "people123"
}
 
```
This example will create the People column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
 {
  "Id": "people123",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns (Country)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "country",
  "Title": "Country",
  "Id": "country"
}
```
This example will create the Country column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "country",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns (Hour)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "hour",
  "Title": "Hour",
  "Id": "hour"
}
 
```
This example will create the Hour column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "hour",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Link)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "link",
  "Title": "LINK",
  "Id": "linkurl"
}
 
```
This example will create the Link column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
 {
  "Id": "linkurl",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns (Location)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "location",
  "Title": "Location",
  "Id": "location"
}
 
```
This example will create the Location column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "location",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Rating)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "rating",
  "Title": "Rating",
  "Id": "rating123"
}
 
```
This example will create the Rating column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
 {
  "Id": "rating123",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Timeline)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
  {
  "BoardId": "1922602090",
  "Type": "timeline",
  "Title": "Timeline",
  "Id": "timeline"
}
 
```
This example will create the Timeline column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "timeline",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(Week)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
  {
  "BoardId": "1922602090",
  "Type": "week",
  "Title": "Week",
  "Id": "week_12"
}
```
This example will create the Week column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "Id": "week_12",
  "BoardId": "1922602090"
}
```

Example - Create entity Columns(WorldClock)

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "BoardId": "1922602090",
  "Type": "world_clock",
  "Title": "World Clock",
  "Id": "world_clock1"
}
```
This example will create the World Clock column. If the integration is successful, the Columns task's connectorOutputPayload response parameter will have a value similar to the following:
```
 {
  "Id": "world_clock1",
  "BoardId": "1922602090"
}
```

Example - Create entity GoogleTestingProject(SubItem)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Create operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.
```
{
  "ParentItemId": "1901835811",
  "Subitem": "Cloud_Sub-Item NAme"
}
 
```
This example will create the SubItem. If the integration is successful, the GoogleTestingProject task's connectorOutputPayload response parameter will have a value similar to the following:
```
{
  "ItemId": "1901893886"
}
```

Example - Update entity Workspaces

In the Configure connector task dialog, click Entities.
Select Workspaces from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "Description": "Updated Workspace",
  "Name": "Riky's Updated Workspace"
}
```
Instead of specifying the entityId, you can also set the filterClause to 964218.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "Id": "964218"
}
```

Example - Update entity Boards

In the Configure connector task dialog, click Entities.
Select Boards from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "State": "archived"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1899875405.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "Id": "1899875405"
}
```

Example - Update entity Group

In the Configure connector task dialog, click Entities.
Select Group from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "Color": "#FFCB00"
}
```
Instead of specifying the entityId, you can also set the filterClause to Id='new_demo_group4301__1' and BoardId='1899350039'.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "Id": "new_demo_group4301__1",
  "BoardId": "1899350039"
}
```

Example - Update entity GoogleTestingProject(Date)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "Datetime": "2024-08-14 01:00:00.0"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1903603203.

If the integration is successful, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:
```
{
  "ItemId": "1903603203"
}
```

Example - Update entity GoogleTestingProject(Dropdown)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "DropdownText": "Cloud"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1901835811.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1901835811"
}
```

Example - Update entity GoogleTestingProject(Email)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "EmailLabel": "NewMail",
  "Email": "Cloudmonday@gmail.com"
} 
```
Instead of specifying the entityId, you can also set the filterClause to 1901835811.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1901835811"
} 
```

Example - Update entity GoogleTestingProject(LongText)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "Long text": "Long text has been updated."
} 
```
Instead of specifying the entityId, you can also set the filterClause to 1904252262.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1904252262"
}
```

Example - Update entity GoogleTestingProject(Number)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "Numbers": 85.0
}
```
Instead of specifying the entityId, you can also set the filterClause to 1904252262.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1904252262"
}
```

Example - Update entity GoogleTestingProject(Phone)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "Phone": "7869514320",
  "PhoneCountryShortName": "US"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1904260492.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1904260492"
}
```

Example - Update entity GoogleTestingProject(Text)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "Text": "Integration Monday"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1904265740.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1904265740"
} 
```

Example - Update entity GoogleTestingProject(SubItem)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "World clock": "Asia/New Delhi",
  "Numbers": 23.0,
  "PhoneCountryShortName": "IN",
  "Phone": "9876543210"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1904265740.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1904265740"
}
```

Example - Update entity GoogleTestingProject(People)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
  "PeopleValue": "{\"personsAndTeams\":[{\"id\":\"64427450\",\"kind\":\"person\"},{\"id\":\"64384966\",\"kind\":\"person\"}]}"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1904265740.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1904265740"
} 
```

Example - Update entity GoogleTestingProject(Timeline)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
"TimelineFrom": "2024-08-23",
"TimelineTo": "2024-08-27"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1920283144.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1920283144"
} 
```

Example - Update entity GoogleTestingProject(Week)

In the Configure connector task dialog, click Entities.
Select GoogleTestingProject from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
{
"WeekFrom": "2024-08-26",
"WeekTo": "2024-09-01"
}
```
Instead of specifying the entityId, you can also set the filterClause to 1920283144.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "ItemId": "1920283144"
}
```

Example - Update entity Columns

In the Configure connector task dialog, click Entities.
Select Columns from the Entity list.
Select the Update operation, and then click Done.
In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.
```
 {
  "Description": "People Information"
} 
```
Instead of specifying the entityId, you can also set the filterClause to 1922602090.

If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
  "Id": "people1",
  "BoardId": "1922602090"
}
```

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next

Understand how to suspend and resume a connection.
Understand how to monitor connector usage.
Understand how to view connector logs.