monday apps framework

The monday apps framework Developer Hub

Welcome to the monday apps framework developer hub. You'll find comprehensive guides and documentation to help you start working with monday apps framework as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Built-in Trigger Blocks

Here is a comprehensive list of all of our current, built-in triggers for your integration recipe trigger blocks.

What are monday Trigger Blocks?

Whether you're just dipping your toes into the monday apps framework, or looking to build an integration recipe without building a custom trigger, our monday trigger blocks are right for you. These 14 trigger blocks allow you to build out your custom recipes with ease.

To utilize a monday trigger block, choose any of the listed triggers in the left hand panel of your custom recipe:

actions gifactions gif

When an Item is Created

This trigger will run when a new item is created on a particular board.

Input Fields:

Type ID Description
Board
boardId This is the Board ID you are tracking for newly created items

Output Fields:

When a Column Changes

This trigger will run when the selected column within the recipe has a value change; For example, if you select a Text column, and the text within the column changes from “Hello” to “Hello World”

Input Fields:

Type ID Description
Board boardId This is the board ID where the item was created. Will be the same as the boardId in the input field
Item itemId This will return the item ID that is created
User userId This will return the user ID who created the item
Top Group isTopGroup Will return “true” if the item is in the first Group on the board
Type ID Description
Board boardId This is the Board ID you are tracking for new column changes
Column columnId This is the column you are tracking for changes

Output Fields:

Type ID Description
Item itemId The item ID where the column change occurred
Board boardId The Board ID where the column change occurred
Column columnId The Column ID where the column change occurred
General Column Value columnValue This will provide the new value of the changed column
General Column Value previousColumnValue This will provide the previous value of the changed column
Top Group isTopGroup This will return “true” if the item is in the first group on the board
Column Type columnType This will return the column type for the column that changed (in accordance with our API)
User userId This will contain the User ID who initiated the change
Item Mapping itemValues This will contain the item mapping values that will be returned as a payload like this: Useful for moving items to a different board, or creating items based on an original item, etc.

Scheduled Trigger

This trigger will run based on a certain schedule. For example, 7 days before the Date arrives at 7 PM - this is when the trigger will call your endpoint with values.

Input Fields:

Type ID Description
Board boardId The board ID that will run the scheduled trigger on a recurring basis
Configuration for Scheduled Automations dateTriggerConfig The configuration for the schedule of the trigger to run, at specific time intervals and specific hours. For example, 3 days before date arrives at 7 AM.
Date / Timeline column columnId The column ID of a Date or Timeline column to be referenced

Output Fields:

Type ID Description
Board boardId The board ID where a date arrived according to the scheduling config for the trigger to run
Item itemId The item ID where the scheduling trigger had run
User userId The user ID of the recip who added the recipe

When an Item is Moved to a Group

This trigger will run when an item is moved to a specific group within a board.

Input Fields:

Type ID Description
Board boardId The board ID that the recipe will track for item movement
Group groupId The group ID that will be tracked for new items to be moved to them

Output Fields:

Type ID Description
Item itemId Will return the item ID that was moved to the group selected in the trigger
Board boardId Will return the board ID where the item was moved
User userId Will return the ID of the user who moved the item
Group groupId Will return the current group ID of the item that was moved
Top Group isTopGroup Will return “true” if the item was moved to the Top Group of the board
Group previousGroupId Will return the Group ID of the item before the move took place
Item Mapping itemValues This will contain the item mapping values that will be returned as a payload like this: Useful for moving items to a different board, or creating items based on an original item, etc.

When an Item is Moved to a Board

This trigger will run when an item is moved to any group within a particular board;

Input Fields:

Type ID Description
Board boardId The board ID to track for item movement

Output Fields:

Type ID Description
Board boardId Will return the board ID where the item was moved to
Previous Board ID previousBoardID Will return the board ID where the item was previously located in
Item itemId Will return the item ID that was moved to the board where the recipe was added
User userId Will return the User ID that moved the item
Top Group isTopGroup Will return “true” if the item is placed in the top group within a board
Group groupId Will return the Group ID that the item was placed in
Previous Group ID previousGroupId Will return the Group ID where the item was located before
Item Mapping itemValues This will contain the item mapping values that will be returned as a payload like this: Useful for moving items to a different board, or creating items based on an original item, etc.

When an Update is Created

This trigger will run if any update is added to any of the items within the board where the recipe is added.

Input Fields:

Type ID Description
Board boardId Will return the Board ID where the recipe is added

Output Fields:

Type ID Description
Board boardID Will return the Board ID that the update was posted in
Item itemId Will return the Item ID where the update was posted
Text textBody Will return the unformatted text of the update
Text body Will return the text of the update, including formatting. You can find an example of the value returned further down below.
User userId Will return the User ID of the user who posted the update
Update

updateId Will return the Update ID. This could be useful to add files to this specific update, for example.
Update Reply replyId Will return Reply ID, if the Update was posted as a reply to a conversation

Here's an example of the body Output Field value:

“text”:”<p><strong> Hey, I appreciate you reading this! </strong></p>”,
“textBody”: “Hey, I appreciate you reading this”

Recurring

This is a trigger that will run on a certain schedule on a recurring basis. For example, `Every 7 days at 11 AM, create a new item.

Input Fields:

Type ID Description
Board boardId This is the Board ID where the integration recipe is added
Configuration for Recurring Automations schedulerConfig Will be used as the setup for the recipe, for example:

When Status Changes

This trigger will call your endpoint when a Status column within a board changes.

Input Fields:

Type ID Description
Board boardId This is the board ID where you’ve added the recipe
Column columnId This is the Status column you can select to track changes

Output Fields:

Type ID Description
Item itemId Will return the item ID where the status change took place
Board boardId Will return the board ID where the status change took place
Status Column columnId Will return the Column ID where the status change took place
Status Column Value columnValue Will return the current status value of the column, including the index and label
Status Column value (previous) previousColumnValue Will return the previous status value of the column, including the index and label
Is Top Group isTopGroup Will return “true” if the item is in the top group within the board
Column Type columnType Will return the column type of the column where the change occurred. The column type will be “color” for Status columns.
Item Mapping itemValues This will contain the item mapping values that will be returned as a payload like this: Useful for moving items to a different board, or creating items based on an original item, etc.

When Date is Set

This trigger will run when a Date column value is added to a specific column within the board;

Input Fields:

Type ID Description
Board boardId This is the Board where you add the recipe
Column columnId This is the Date column that will be referenced

Output Fields:

Type ID Description
Item itemId Will return the Item ID where the Date was set
Board boardId Will return the Board ID where the Date was set
Date Column (will not accept Date/Timeline column) columnId Will return the Column ID where the Date was set
Date Column Value columnValue Will return the Date value in YYYY-MM-DD format
Date Column Value (previous) previousColumnValue Will return the previous value of the Date column in YYYY-MM-DD format
Is Top Group isTopGroup Will return “true” if the item is in the first group within a board
Column Type columnType Will return the column type used for the integration

When Person is Assigned

This trigger will run when a user is assigned to a People column.

Input Fields:

Type ID Description
Board boardId This is the Board ID you are tracking for People column changes
People column columnId This is the People column to reference for changes

Output Fields:

Type ID Description
Item itemId Will return the Item ID where the People column was changed
Board boardId Will return the Board ID where the People column was changed
People Column columnId Will return the People column ID that was changed
People Column Value columnValue Will return the current value of the People column after the change
People Column Value previousColumnValue Will return the current value of the People column before the change
Is Top Group isTopGroup Will return “true” if the item is in the first group within a board
Column Type columnType Will return the column type of the People column where the change occurred

When any Column Changes

This trigger will run when any column changes on the board where the recipe was added.

Input Fields:

Type ID Description
Board boardId The board ID to be watched for any column changes

Output Fields:

Type ID Description
Item itemId Will return the Item ID where the column values changed
Board boardId Will return the Board ID where the column values changed
Column columnId Will return the Column ID where the column values changed
General Column Value columnValue Will return the current column values after the change took place
General Column Value (previous) previousColumnValue Will return the current column values before the change took place
Is Top Group isTopGroup Will return “true” if the item is i in the first group within a board
columnType columnType Will return the column type where the change took place
Item Mapping itemValues This will contain the item mapping values that will be returned as a payload like this: Useful for moving items to a different board, or creating items based on an original item, etc.

When a Status Changes to Something

This trigger will only run when a specific Status column changes to a particular value in the board where the recipe was added.

Input Fields:

Type ID Description
Board boardId This is the board to watch for specific Status column changes
Status Column columnId This is the column that will be watched for specific value changes
Status Column Value columnValue This is a value picker using Status column labels

Output Fields:

Type ID Description
Item itemId Will return the Item ID where the Status column was changed to a specific value
Board boardId Will return the Board ID where the Status column was changed to a specific value
Status Column columnId Will return the Column ID where the Status column was changed to a specific value
Status Column Value columnValue Will return the current Status column value after the change took place
Status Column Value (previous) previousColumnValue Will return the previous Status column value before the change took place
Is Top Group isTopGroup Will return “true” if the item is in the first group within a board
Column Type columnType Will return the column type of the column where the value changed. The Status column type is “color."
Item Mapping itemValues This will contain the item mapping values that will be returned as a payload like this: Useful for moving items to a different board, or creating items based on an original item, etc.

Every day if date has passed

This trigger will run at 12 AM, based on the timezone of the user who added the recipe, and when a date arrives. For example, if a Date column has March 15th and March 20th selected in Date column cells, the trigger will run when March 20th arrives at 12 AM for the user who added the recipe to the board.

Input Fields:

Type ID Description
Board boardId This is the board you are watching for dates to arrive in a Date or Timeline column
Date / Timeline column columnId This is the column that will be watched for dates to arrive

Output Fields:

Type ID Description
Board boardId This is the Board ID where the date arrived. This will trigger at 12 AM based on the timezone of the user who added the recipe.
Item itemId This is the Item ID where the date arrived. This will trigger at 12 AM based on the timezone of the user who added the recipe.
User userId This will return the User ID of the user who added the recipe

When Button Clicked

This trigger will run when a specific button column is clicked on the board where the recipe was added.

Input Fields:

Type ID Description
Board boardId This is the board ID to watch for button clicks
Column columnId This is the Button Column to select as the trigger in the recipe

Output Fields:

Type ID Description
Item itemId Will return the Item ID where the button was clicked
Board boardId Will return the Board ID where the button was clicked
Column columnId Will return the Column ID where the Button was clicked
Button Column Value columnValue Will return the column values of the Button column after it was clicked. For example:

"buttonColumnValue": {
"clicks": 6,
"changed_at": "2021-03-16T09:30:37.061Z",
"column_settings": {
"buttonText": "Click me",
"color": "#579bfc" 0
Button Column Previous Value previousColumnValue Will return the column values of the Button Column before it was clicked, for example:

"buttonColumnValue": {
"clicks": 5,
"changed_at": "2021-03-16T09:30:30.00:48",
"column_settings": {
"buttonText": "Click me",
"color": "#579bfc"
Is Top Group isTopGroup Will return “true” if the item is in the first group within a board
Column Type columnType Will return the column type of the column that triggered the recipe
User userId Will return the User ID that clicked the button
Item Mapping itemValues This will contain the item mapping values that will be returned as a payload like this: Useful for moving items to a different board, or creating items based on an original item, etc.

Congratulations Builder!

You now know the ins and outs of how data is transferred to, and between, the blocks in your integration recipes.

As a next step, check out the following resources:

Updated 2 months ago


Built-in Trigger Blocks


Here is a comprehensive list of all of our current, built-in triggers for your integration recipe trigger blocks.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.