> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Trello

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZAT7K4J1JWT5VCV838TFRN)
*v2.1.3*

![](https://mintcdn.com/botpress/KbMT91f_P0tr2fc3/integrations/integration-guides/assets/trello.png?fit=max\&auto=format\&n=KbMT91f_P0tr2fc3\&q=85\&s=e68027ce25e025fa5e15ac072ac0fc40)

This integration allows you to connect your Botpress bot with Trello, a leading project management platform. With this integration, you can easily manage your boards, lists and cards directly from your bot.

## Prerequisites

* A [Trello account](https://trello.com/)
* A board in Trello, with at least one list
* The ID of the list where cards will be created. Refer to [this article](https://community.atlassian.com/t5/Trello-questions/How-do-I-find-the-LIST-ID/qaq-p/2272862) to locate it.
* A [Botpress Cloud account](https://sso.botpress.cloud) and a [Botpress Bot](https://botpress.com/docs/get-started/quick-start.md)

## Setup in Botpress

1. Go to the [Integration Hub](https://app.botpress.cloud/hub) in Botpress Cloud (if you don't have the integration installed yet).
2. Find and open the Trello integration then click on the "Install to Bot" button, now go back to your bot settings.

The Trello integration has the following settings:

* **Enabled**: Whether Botpress will communicate with Trello
* **Webhook URL**: The URL for receiving data in Botpress
* **API Key**: The API key for the Trello Power-Up
* **Token**: The token for the Trello Power-Up

## Setup in Trello

1. Visit the [Power-Ups Admin Page](https://trello.com/power-ups/admin) and click the **New** button to obtain the API key. Name the Power-Up as "Botpress Connector", fill in the email and author fields, then click **Create**.
2. Once the Power-Up is created, you will be redirected to API Key settings page, displayed below. Generate a new API key, then copy and paste this key into the **API Key** field in Botpress.

![](https://mintcdn.com/botpress/KbMT91f_P0tr2fc3/integrations/integration-guides/assets/trello-apikey.png?fit=max\&auto=format\&n=KbMT91f_P0tr2fc3\&q=85\&s=00af53dce93485534ebda0bb7ad67486)

3. Click on the "Token" link (marked in the image below) and authorize the Power-Up access to your Trello account by selecting **Allow**.

![](https://mintcdn.com/botpress/KbMT91f_P0tr2fc3/integrations/integration-guides/assets/trello-token.png?fit=max\&auto=format\&n=KbMT91f_P0tr2fc3\&q=85\&s=400eb465a032f2437c6b2d4245c81f7a)

4. After authorization, copy the displayed token and paste it into the **Token** field in Botpress.
5. Make sure the integration is enabled then press the button "Save configuration".

That's it! Now the Trello integration is operational and ready for use within your bot.

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Add card comment

Add a new comment to a card

**input** `object`

Input schema for adding a comment to a card

**cardId** `string` *required*

Unique identifier of the card to which a comment will be added

**commentBody** `string` *required*

The body text of the comment

**output** `object`

**message** `string` *required*

A message that says if the comment was successfully created or not

**newCommentId** `string` *required*

Unique identifier of the newly created comment

### Create new card

Create a card and add it to a list

**input** `object`

Input schema for creating a new card

**listId** `string` *required*

ID of the list in which to insert the new card

**cardName** `string` *required*

Name of the new card

**cardBody** `string`

The body text of the new card

**memberIds** `array`

Members to add to the card (Optional). This should be a list of member IDs.

**labelIds** `array`

Labels to add to the card (Optional). This should be a list of label IDs.

**dueDate** `string (date-time)`

The due date of the card in ISO 8601 format (Optional).

**completionStatus** `enum\<string\>` (default: Incomplete)

Whether the card should be marked as complete (Optional). Enter "Complete" or "Incomplete" (without quotes).

Available options: `Complete`, `Incomplete`

**output** `object`

Output schema for creating a card

**message** `string` *required*

A message that says if the card was successfully created or not

**newCardId** `string` *required*

Unique identifier of the new card

### Delete card

Deletes a card by its unique identifier

**input** `object`

**cardId** `string` *required*

ID of the card to delete

**hardDelete** `boolean` (default: false)

Whether to perform a hard delete or a soft delete (archive). Set to true for hard delete, false for soft delete.

**output** `object`

This Card has no output.

### Get all board members

Get all members of a board

**input** `object`

Input schema for getting all members of a board

**boardId** `string` *required*

Unique identifier of the board

**output** `object`

**members** `array` *required*

A list of members who have access to the board

**array item properties**

**id** `string` *required*

Unique identifier of the member

**username** `string` *required*

A public alias that represents the member

**fullName** `string` *required*

Full name of the member

### Get all boards

Get all boards managed by the authenticated user

**input** `object`

This Card has no input fields.

**output** `object`

**boards** `array` *required*

A list of Trello boards

**array item properties**

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

### Get all card members

Get all members of a card

**input** `object`

Input schema for getting all members of a card

**cardId** `string` *required*

Unique identifier of the card

**output** `object`

**members** `array` *required*

A list of members who have been assigned to the card

**array item properties**

**id** `string` *required*

Unique identifier of the member

**username** `string` *required*

A public alias that represents the member

**fullName** `string` *required*

Full name of the member

### Get board by ID

Get a board by its unique identifier

**input** `object`

Input schema for getting a board from its ID

**boardId** `string` *required*

Unique identifier of the board

**output** `object`

**board** `object` *required*

The details of the Trello board associated with the given ID

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

### Get members by name

Find all members whose display name match this name

**input** `object`

**boardId** `string` *required*

Unique identifier of the board

**displayName** `string` *required*

Display name of the member

**output** `object`

**members** `array` *required*

A list of members that match the specified name

**array item properties**

**id** `string` *required*

Unique identifier of the member

**username** `string` *required*

A public alias that represents the member

**fullName** `string` *required*

Full name of the member

### Get boards by name

Find all boards whose display name match this name

**input** `object`

Input schema for getting a board ID from its name

**boardName** `string` *required*

Display name of the board

**output** `object`

**boards** `array` *required*

A list of boards that match the given display name

**array item properties**

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

### Get card by ID

Get a card by its unique identifier

**input** `object`

Input schema for getting a card from its ID

**cardId** `string` *required*

Unique identifier of the card

**output** `object`

**card** `object` *required*

The Trello card that's associated with the given card ID

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**description** `string` *required*

Detailed description of the card

**listId** `string` *required*

Identifier of the list the card belongs to

**verticalPosition** `number` *required*

Position of the card within the list

**isClosed** `boolean` *required*

Indicates if the card is closed

**isCompleted** `boolean` *required*

Indicates if the card is completed

**dueDate** `string (date-time)`

The expected completed by date (Optional)

**labelIds** `array` *required*

A list of label IDs attached to the card

**memberIds** `array` *required*

A list of member IDs assigned to the card

### Find cards by name

Find all cards whose display name match this name

**input** `object`

Input schema for getting a card ID from its name

**listId** `string` *required*

Unique identifier of the list

**cardName** `string` *required*

Display name of the card

**output** `object`

**cards** `array` *required*

A list of cards that match the given card name

**array item properties**

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**description** `string` *required*

Detailed description of the card

**listId** `string` *required*

Identifier of the list the card belongs to

**verticalPosition** `number` *required*

Position of the card within the list

**isClosed** `boolean` *required*

Indicates if the card is closed

**isCompleted** `boolean` *required*

Indicates if the card is completed

**dueDate** `string (date-time)`

The expected completed by date (Optional)

**labelIds** `array` *required*

A list of label IDs attached to the card

**memberIds** `array` *required*

A list of member IDs assigned to the card

### Get cards in list

Get all cards in a list

**input** `object`

Input schema for getting all cards in a list

**listId** `string` *required*

Unique identifier of the list

**output** `object`

**cards** `array` *required*

An array of cards that are contained within the given list

**array item properties**

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**description** `string` *required*

Detailed description of the card

**listId** `string` *required*

Identifier of the list the card belongs to

**verticalPosition** `number` *required*

Position of the card within the list

**isClosed** `boolean` *required*

Indicates if the card is closed

**isCompleted** `boolean` *required*

Indicates if the card is completed

**dueDate** `string (date-time)`

The expected completed by date (Optional)

**labelIds** `array` *required*

A list of label IDs attached to the card

**memberIds** `array` *required*

A list of member IDs assigned to the card

### Get list by ID

Get a list by its unique identifier

**input** `object`

Input schema for getting a list from its ID

**listId** `string` *required*

Unique identifier of the list

**output** `object`

**list** `object` *required*

The Trello list that's associated with the given list ID

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

### Get lists by name

Find all lists whose display name match this name

**input** `object`

Input schema for getting a list ID from its name

**boardId** `string` *required*

Unique identifier of the board

**listName** `string` *required*

Display name of the list

**output** `object`

**lists** `array` *required*

A set of lists that are associated with the given board ID and match the given display name

**array item properties**

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

### Get lists in board

Get all lists in a board

**input** `object`

Input schema for getting all lists in a board

**boardId** `string` *required*

Unique identifier of the board

**output** `object`

**lists** `array` *required*

A set of all the lists that are associated with the given board ID

**array item properties**

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

### Get member by ID or username

Get a member by their unique identifier or username

**input** `object`

Input schema for getting a member from its ID or username

**memberIdOrUsername** `string | string` *required*

ID or username of the member to get

**output** `object`

**member** `object` *required*

The Trello member who is associated with the specified member ID or username

**id** `string` *required*

Unique identifier of the member

**username** `string` *required*

A public alias that represents the member

**fullName** `string` *required*

Full name of the member

### Move card down

Move a card n spaces down

**input** `object`

**cardId** `string` *required*

Unique identifier of the card

**moveDownByNSpaces** `number` (default: 1)

Number of spaces by which to move the card down

**output** `object`

Output schema for moving a card down

**message** `string` *required*

Output message

### Move card to another list

Move a card to another list within the same board

**input** `object`

**cardId** `string` *required*

Unique identifier of the card

**newListId** `string` *required*

Unique identifier of the list in which the card will be moved to

**newVerticalPosition** `string`

The new position of the card in the list, either "top", "bottom", or a stringified float (Optional). Leave empty to keep the current position.

**output** `object`

Output schema for moving a card to a list

**message** `string` *required*

Output message

### Move card up

Move a card n spaces up

**input** `object`

**cardId** `string` *required*

Unique identifier of the card

**moveUpByNSpaces** `number` (default: 1)

Number of spaces by which to move the card up

**output** `object`

Output schema for moving a card up

**message** `string` *required*

Output message

### Update card

Update the details of a card

**input** `object`

Input schema for creating a new card

**cardId** `string` *required*

Unique identifier of the card

**cardName** `string`

The name of the card (Optional) (e.g. "My Test Card"). Leave empty to keep the current name.

**cardBody** `string`

The new body text of the card (Optional). Leave empty to keep the current body.

**lifecycleStatus** `enum\<string\>`

Whether the card should be archived (Optional). Enter "Open", "Archived" (without quotes), or leave empty to keep the previous status.

Available options: `Open`, `Archived`

**completionStatus** `enum\<string\>`

Whether the card should be marked as complete (Optional). Enter "Complete", "Incomplete" (without quotes), or leave empty to keep the previous status.

Available options: `Complete`, `Incomplete`

**memberIdsToAdd** `array`

Members to add to the card (Optional). This should be a list of member IDs. Leave empty to keep the current members.

**memberIdsToRemove** `array`

Members to remove from the card (Optional). This should be a list of member IDs. Leave empty to keep the current members.

**labelIdsToAdd** `array`

Labels to add to the card (Optional). This should be a list of label IDs. Leave empty to keep the current labels.

**labelIdsToRemove** `array`

Labels to remove from the card (Optional). This should be a list of label IDs. Leave empty to keep the current labels.

**dueDate** `string | null`

**listId** `string`

Unique identifier of the list in which the card will be moved to

**verticalPosition** `string`

The new position of the card in the list, either "top", "bottom", or a stringified float (Optional). Leave empty to keep the current position.

**output** `object`

Output schema for updating a card

**message** `string` *required*

Output message

***

## Triggers

{/* vale off */}

Here's a reference for all [Triggers](https://botpress.com/docs/studio/concepts/triggers.md) available with the integration:

> [!TIP]
>
> You can access data returned from any of these Triggers by reading `event.payload` after the Trigger fires.

### Card Attachment Added

Triggered when an attachment is added to a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**list** `object` *required*

List where the card was updated

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**attachment** `object` *required*

Attachment that was added to the card

**id** `string` *required*

Unique identifier of the attachment

**name** `string` *required*

Name of the attachment

**url** `string (uri)` *required*

URL of the attachment

**previewUrl** `string (uri)`

URL of the attachment preview

**previewUrl2x** `string (uri)`

URL of the attachment preview at up to 2x the resolution

### Checklist Added To Card

Triggered when a checklist is added to a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**checklist** `object` *required*

Checklist that was added to the card

**id** `string` *required*

Unique identifier of the checklist

**name** `string` *required*

Name of the checklist

### Card Label Added

Triggered when a label is added to a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was modified

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was modified

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**label** `object` *required*

Label that was added to the card

**id** `string` *required*

Unique identifier of the label

**name** `string` *required*

Name of the label

**color** `string` *required*

Color of the label

### Member Added To Card

Triggered when a member is added to a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that the member was added to

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**member** `object` *required*

Member that was added to the card

**id** `string` *required*

Unique identifier of the member

**name** `string` *required*

Full name of the member

### Comment Created

Triggered when a comment is added to a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**list** `object` *required*

List where the card was updated

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**comment** `object` *required*

Comment that was added to the card

**id** `string` *required*

Unique identifier of the comment

**text** `string` *required*

Text of the comment

### Card Created

Triggered when a card is created

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was created

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**list** `object` *required*

List where the card was created

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

**card** `object` *required*

Card that was created

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

### Checklist Item Created

Triggered when a checklist item is added to a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**checklist** `object` *required*

Checklist where the item was added

**id** `string` *required*

Unique identifier of the checklist

**name** `string` *required*

Name of the checklist

**checklistItem** `object` *required*

The checklist item that was added

**id** `string` *required*

Unique identifier of the checklist item

**name** `string` *required*

Name of the checklist item

**isCompleted** `boolean` *required*

Indicates if the checklist item is marked as completed

**textData** `object` *required*

Text data of the checklist item

**emoji** `object` *required*

Emoji of the checklist item

### Card Attachment Removed

Triggered when an attachment is removed from a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**attachment** `object` *required*

Attachment that was deleted from the card

**id** `string` *required*

Unique identifier of the attachment

**name** `string` *required*

Name of the attachment

### Card Deleted

Triggered when a card is deleted

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was deleted

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**list** `object` *required*

List where the card was deleted

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

**card** `object` *required*

Card that was deleted

**id** `string` *required*

Unique identifier of the card

### Checklist Item Deleted

Triggered when a checklist item is removed from a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**checklist** `object` *required*

Checklist where the item was removed

**id** `string` *required*

Unique identifier of the checklist

**name** `string` *required*

Name of the checklist

**checklistItem** `object` *required*

Checklist item that was removed

**id** `string` *required*

Unique identifier of the checklist item

**name** `string` *required*

Name of the checklist item

**isCompleted** `boolean` *required*

Indicates if the checklist item is marked as completed

**textData** `object` *required*

Text data of the checklist item

**emoji** `object` *required*

Emoji of the checklist item

### Comment Deleted

Triggered when a comment is deleted from a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**comment** `object` *required*

Comment that was deleted from the card

**id** `string` *required*

Unique identifier of the comment

### Card Label Removed

Triggered when a label is removed from a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was modified

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was modified

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**label** `object` *required*

Label that was removed from the card

**id** `string` *required*

Unique identifier of the label

**name** `string` *required*

Name of the label

**color** `string` *required*

Color of the label

### Member Removed From Card

Triggered when a member is removed from a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**member** `object` *required*

Member that was removed from the card

**id** `string` *required*

Unique identifier of the member

**name** `string` *required*

Full name of the member

**deactivated** `boolean` *required*

Indicates if the member was deactivated at the time of removal

### Card Updated

Triggered when a card is updated

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

Name of the card

**description** `string`

Description of the card

**listId** `string`

Unique identifier of the list where the card is located

**labelIds** `array`

Labels attached to the card

**verticalPosition** `number`

Position of the card within the list

**startDate** `string | null`

**dueDate** `string | null`

**dueDateReminder** `integer`

The number of minutes before the due date when a reminder will be sent

**isCompleted** `boolean`

Whether the card is completed

**isArchived** `boolean`

Whether the card is archived

**old** `object` *required*

Previous state of the card

**name** `string`

Name of the card

**description** `string`

Description of the card

**listId** `string`

Unique identifier of the list where the card is located

**labelIds** `array`

Labels attached to the card

**verticalPosition** `number`

Position of the card within the list

**startDate** `string | null`

**dueDate** `string | null`

**dueDateReminder** `integer`

The number of minutes before the due date when a reminder will be sent

**isCompleted** `boolean`

Whether the card is completed

**isArchived** `boolean`

Whether the card is archived

**list** `object`

List where the card was updated

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

**listBefore** `object`

Previous list where the card was located

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

**listAfter** `object`

New list where the card is now located

**id** `string` *required*

Unique identifier of the list

**name** `string` *required*

The name of the list

### Checklist Item Updated

Triggered when a checklist item is modified on a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**checklist** `object` *required*

Checklist where the item was updated

**id** `string` *required*

Unique identifier of the checklist

**name** `string` *required*

Name of the checklist

**checklistItem** `object` *required*

Checklist item that was updated

**id** `string` *required*

Unique identifier of the checklist item

**name** `string` *required*

Name of the checklist item

**isCompleted** `boolean` *required*

Indicates if the checklist item is marked as completed

**textData** `object` *required*

Text data of the checklist item

**emoji** `object` *required*

Emoji of the checklist item

**dueDateReminder** `integer`

The number of minutes before the due date when a reminder will be sent

**dueDate** `string | null`

**old** `object` *required*

The previous data of the checklist item

**name** `string`

Name of the checklist item

**isCompleted** `boolean`

Indicates if the checklist item is marked as completed

**textData** `object`

Text data of the checklist item

**emoji** `object` *required*

Emoji of the checklist item

**dueDateReminder** `integer`

The number of minutes before the due date when a reminder will be sent

**dueDate** `string | null`

### Checklist Item Completion Updated

Triggered when the completion status of a checklist item is updated

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**checklist** `object` *required*

Checklist where the item was updated

**id** `string` *required*

Unique identifier of the checklist

**name** `string` *required*

Name of the checklist

**checklistItem** `object` *required*

Checklist item that was updated

**id** `string` *required*

Unique identifier of the checklist item

**name** `string` *required*

Name of the checklist item

**isCompleted** `boolean` *required*

Indicates if the checklist item is marked as completed

**textData** `object` *required*

Text data of the checklist item

**emoji** `object` *required*

Emoji of the checklist item

### Comment Updated

Triggered when a comment is updated on a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**comment** `object` *required*

Comment that was updated

**id** `string` *required*

Unique identifier of the comment

**text** `string` *required*

Text of the comment

**old** `object` *required*

The previous data of the comment

**text** `string` *required*

Text of the comment

### Card Votes Updated

Triggered when a vote is added to or removed from a card

**payload** `object`

**eventId** `string` *required*

Unique identifier of the event

**actor** `object | object` *required*

The actor (e.g. member or app) who triggered the event

**dateCreated** `string (date-time)` *required*

The datetime when the event was triggered

**board** `object` *required*

Board where the card was updated

**id** `string` *required*

Unique identifier of the board

**name** `string` *required*

The name of the board

**card** `object` *required*

Card that was updated

**id** `string` *required*

Unique identifier of the card

**name** `string` *required*

The preview name of the card

**voted** `boolean` *required*

Whether the user voted on the card


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.