Monday
Related pages:
Monday component
Description
The Monday Component facilitates interaction with the Monday API. This version of the component has been tested with API version 2024-01
, utilizing https://api.monday.com/v2/
as the base path.
Credentials
To embark on building any integration flow, the initial step involves creating an app by following these steps:
- Click on your profile picture at the top right corner.
- Choose Developers to navigate to the Developer Center in a new tab.
- In the new tab, select Create app.
- Enter the desired Name. On this page, you’ll also need to note the
Client ID
andClient Secret
. - Navigate to the OAuth section in the left-side menu.
- Choose the appropriate Scopes.
- Input the Redirect URLs as
https://{your-tenant-address}/callback/oauth2
, where{your-tenant-address}
is the domain of the integration platform.
With the app created, proceed to generate new credentials for the component:
- Type (dropdown, required) -
OAuth2
. - Choose Auth Client (dropdown, required) - choose from previously created clients or select
Add New Auth Client
:- Name (string, required) - Assign any desired name.
- Client ID (string, required) - Enter the
Client ID
found in your app’sBasic Information
. - Client Secret (string, required) - Enter the
Client Secret
from your app’sBasic Information
. - Authorization Endpoint (string, required) - Use Monday’s
OAuth2
authorization endpointhttps://auth.monday.com/oauth2/authorize
. - Token Endpoint (string, required) - Use Monday’s refresh token endpoint
https://auth.monday.com/oauth2/token
.
- Name Your Credential (string, required) - Choose any name you prefer.
- Scopes (Comma-separated list) (string, required) - Specify the scopes to access your Monday objects, e.g.,
me:read
,docs:write
. For more information on scopes, click here. To successfully verify credentials, a minimum ofme:read
is required. - Additional parameters (Comma-separated list) (string, required) - Leave this field blank.
-
API version (For advanced users) (string, optional) - Leaving this blank defaults to the
Current
API version. For details on whatCurrent
entails, refer here.Example value for this field:
2024-01
Triggers
Webhook
Creates a subscription to a selected event.
Required scopes: boards:read
, webhooks:read
, webhooks:write
.
More information can be found here.
Configuration Fields
- Board - (dropdown, required): Select the board where you want to create a subscription.
- Event - (dropdown, required): Select the event that will trigger this webhook.
- Config - (string in JSON format, optional): Add additional configuration if needed.
Output Metadata
An object with the key event
that describes changes.
Actions
Execute mutation
Execute any mutation available on API. This action can be used to Create
, Update
or Delete
Objects and any other operations that affect Monday data.
Configuration Fields
- Mutation type - (dropdown, required): Mutation type to execute. E.g
Add users to team
. - Select basic fields for resulting object - (dropdown, optional): Here provided only basic fields that can be included in resulting object, it may affect on query cost
- You can provide additional fields here - (string, optional): Resulting object can be expanded using GraphQL request, it may affect on query cost
Example for Add users to team
successful_users {
name
email
}
Input Metadata
Dynamically generated fields according to chosen Mutation type
.
Output Metadata
Result object from executed mutation.
Lookup Objects (plural)
Lookup a set of objects by a defined criteria list. Can be emitted differently.
Configuration Fields
- Object Type - (dropdown, required): Object-type to lookup on. E.g
Boards
. - Select basic fields for resulting object - (dropdown, optional): Here provided only basic fields that can be included in the resulting object, it may affect query cost.
- You can provide additional fields here - (string, optional): The resulting object can be expanded using GraphQL request, it may affect query cost.
Example for boards
groups { title id }
- Emit Behavior - (dropdown, required): Defines the way result objects will be emitted, one of
Emit page
orEmit individually
.
Input Metadata
Dynamically generated fields according to the chosen Object type
.
Output Metadata
For Emit Page
mode: An object with key results
that has an array as its value For Emit Individually
mode: Each object that fills the entire message.
Known Limitations
If the response from Monday is not an iterable array, it will be emitted as Emit Individually
regardless of selected Emit Behavior
.
Lookup Object By ID
Lookup a single object by its ID.
Configuration Fields
- Object Type - (dropdown, required): Object-type to lookup on. E.g
Boards
. - Select basic fields for resulting object - (dropdown, optional): Here provided only basic fields that can be included in the resulting object, it may affect query cost.
- You can provide additional fields here - (string, optional): The resulting object can be expanded using GraphQL request, it may affect query cost.
Example for boards
groups { title id }
- Allow zero results - (checkbox, optional): If checked and Object not found, returns empty Object (otherwise throws an error).
Input Metadata
- ID Value - (string, required): Value for ID of the object to lookup.
Output Metadata
Dynamically generated fields according to chosen Object type
and selected fields.
Make Raw Request
Executes custom requests using the straightforward Monday GraphQL API.
Input Metadata
Request Body
- (object, optional): Provide the request body.
Body Example
{
"query" : "query { me { is_guest created_at name id}}"
}
More info:
Output Metadata
- Status Code - (number, required): The HTTP status code of the response.
- HTTP headers - (object, required): The response’s HTTP headers.
- Response Body - (object, optional): The body of the HTTP response.
Known Limitations
- For Lookup actions it is required to fill at least one of the fields
Select basic fields for resulting object
orYou can provide additional fields here
. - There can be only one
Webhook
per event type on each board. The component will delete all older ones. - If the flow with
Webhook
is not real-time, you will need to manually execute it once after the flow is published and started by pressing theRun Now
button and following the URL to trigger the flow subscription process.