Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions website/docs/connect-data/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,18 +282,27 @@ Appsmith also supports integration with various Software as a Service (SaaS) pla

<div className="columnGrid column-three" align="center">
<div className="containerCol">
<a href="/connect-data/reference/salesforce">
<img className="containerImage referenceIcon" src="https://assets.appsmith.com/salesforce-logo.svg" alt="Salesforce"/>
<a href="/connect-data/reference/monday.com">
<img className="containerImage referenceIcon" src="https://assets.appsmith.com/monday.com.png" alt="Monday.com"/>
</a>
</div>
<b><a href="/connect-data/reference/salesforce">Salesforce</a></b>
<b><a href="/connect-data/reference/monday.com">Monday.com</a></b>
</div>

</div>

<div className="containerGrid">

<div className="columnGrid column-one" align="center">
<div className="containerCol">
<a href="/connect-data/reference/salesforce">
<img className="containerImage referenceIcon" src="https://assets.appsmith.com/salesforce-logo.svg" alt="Salesforce"/>
</a>
</div>
<b><a href="/connect-data/reference/salesforce">Salesforce</a></b>
</div>

<div className="columnGrid column-two" align="center">
<div className="containerCol">
<a href="/connect-data/reference/slack">
<img className="containerImage referenceIcon" src="https://assets.appsmith.com/slack.png" alt="Slack"/>
Expand All @@ -302,7 +311,7 @@ Appsmith also supports integration with various Software as a Service (SaaS) pla
<b><a href="/connect-data/reference/slack">Slack</a></b>
</div>

<div className="columnGrid column-two" align="center">
<div className="columnGrid column-three" align="center">
<div className="containerCol">
<a href="/connect-data/reference/twilio">
<img className="containerImage referenceIcon" src="https://assets.appsmith.com/twilio.svg" alt="Twilio"/>
Expand All @@ -311,7 +320,11 @@ Appsmith also supports integration with various Software as a Service (SaaS) pla
<b><a href="/connect-data/reference/twilio">Twilio</a></b>
</div>

<div className="columnGrid column-three" align="center">
</div>

<div className="containerGrid">

<div className="columnGrid column-one" align="center">
<div className="containerCol">
<a href="/connect-data/reference/zendesk">
<img className="containerImage referenceIcon" src="https://assets.appsmith.com/zendesk.png" alt="Zendesk"/>
Expand Down
243 changes: 243 additions & 0 deletions website/docs/connect-data/reference/monday.com.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
# Monday.com

Use the Monday.com SaaS integration to orchestrate boards, items, subitems, and user directories directly from Appsmith. The built-in commands wrap common GraphQL mutations so you can create, update, search, or archive Monday records without wiring custom HTTP requests.

## Connect Monday.com

Authenticate with a personal API token; Monday.com issues these tokens per user and they inherit the same permissions the user has in the UI. Refer to the [monday.com authentication guide](https://developer.monday.com/api-reference/docs/authentication) for the latest token-management steps.

1. In Monday.com, open your profile menu and select **Developers** (all users) or **Administration → Connections → Personal API token** (admins only).
2. Click **API token → Show** to copy the token, or **Regenerate** if you need to rotate credentials.
3. Create a new Monday.com datasource and paste the copied value into the token field.
4. Save the datasource.

## Query Monday.com

Each command below maps to a preset mutation or query. Pick a command in the query editor, fill in the required parameters, and run the action to interact with your boards.

### Create Item

Creates a new item on a board. Optionally target a group, attach an external ID, and hydrate any column values supported on the board.

#### Name `string`

<dd>

Required. Title of the item as it should appear on the board.

</dd>

#### Board Id `string`

<dd>

Required. Numeric board identifier where the item will be created. You can copy it from the board URL (`https://*.monday.com/boards/<boardId>`).

</dd>

#### Group Id `string`

<dd>

Optional. Target group ID if you want the item to start inside a specific group within the board.

</dd>

#### External Id `string`

<dd>

Optional. Custom identifier you maintain in your system. Store the same value to fetch or update the item later via the external ID commands.

</dd>

#### Column Values `string`

<dd>

Optional JSON payload for initializing column data. Structure the string as serialized JSON following Monday’s column schema, for example:

```json
{
"status": "Done",
"person": {
"personsAndTeams": [
{ "id": 12345678, "kind": "person" }
]
}
}
```

</dd>

### Update Item

Updates the attributes of an existing item, including the name and any board-specific columns.

#### Item Id `string`

<dd>

Required. Identifier of the item to update.

</dd>

#### Name `string`

<dd>

Optional. New display name for the item.

</dd>

#### Board Id `string`

<dd>

Required. Board where the item resides; Monday uses this along with the item ID to route the mutation.

</dd>

#### External Id `string`

<dd>

Optional. External reference value you wish to add or update for downstream syncing.

</dd>

#### Column Values `string`

<dd>

Optional JSON string mirroring the board’s column structure. Supply only the fields you want to change.

</dd>

### Get Item by ID

Fetches a single item by its Monday item ID.

#### Item Id `string`

<dd>

Required. Item identifier to retrieve. Use this when you already have the Monday-generated ID from another query or board URL.

</dd>

### Get Item by external ID

Retrieves an item that you previously tagged with an external ID.

#### Board Id `string`

<dd>

Required. Board scope where the external ID exists.

</dd>

#### External Id `string`

<dd>

Required. External identifier stored when the item was created or updated.

</dd>

### Search Items

Searches for items using optional board filtering and pagination controls.

#### Board Id `string`

<dd>

Optional. Filter results to a specific board. Leave empty to search across boards the token can access.

</dd>

#### Pagination Parameters `string`

<dd>

Optional JSON string for pagination options such as page size or cursor tokens. Provide the serialized GraphQL arguments expected by Monday’s search API.

</dd>

### Delete Item

Permanently deletes an item from a board. Use with caution because deletion cannot be undone via the API.

#### Item Id `string`

<dd>

Required. Identifier of the item to delete.

</dd>

### Archive Item

Archives an item without deleting it. Archived items remain accessible in Monday’s recycle bin and can be restored later.

#### Item Id `string`

<dd>

Required. Identifier of the item to archive.

</dd>

### Create Subitem

Creates a subitem under an existing parent item, allowing you to break initiatives into smaller tasks.

#### Name `string`

<dd>

Required. Subitem title.

</dd>

#### Parent Item Id `string`

<dd>

Required. Identifier of the parent item that should own the new subitem.

</dd>

#### Column Values `string`

<dd>

Optional JSON string defining column defaults for the subitem. Matches the subitem board’s column schema.

</dd>

### Search Users

Searches the account’s users or retrieves a specific user by ID.

#### User Id `string`

<dd>

Optional. Provide to fetch details for a single user; leave blank to run a broader user search or directory listing.

</dd>

### Custom GraphQL Action

Builds an ad-hoc GraphQL request when the canned commands do not cover your use case. Configure the method, headers, query/mutation body, and variables inline to call any Monday API supported by your token’s permissions.

Example configuration:

Use the `activity_logs` query to pull board-level audit info—this returns an array of log entries with metadata (timestamps, event names, payload) for the specified board. See Monday’s [activity logs reference](https://developer.monday.com/api-reference/reference/activity-logs) for limits, arguments, and fields.

![Screenshot of Monday.com custom GraphQL action in Appsmith showing query and variables](/img/monday.com_custom_action_example.png)


1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,7 @@ const sidebars = {
'connect-data/reference/hubspot',
'connect-data/reference/jira',
'connect-data/reference/mixpanel',
'connect-data/reference/monday.com',
'connect-data/reference/notion',
'connect-data/reference/outlook',
'connect-data/reference/salesforce',
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.