Quickstart Guide: Integration Recipes
Use this guide to create a simple recipe using our integrations template.
Build your first integration recipe from a template
In this article, we are going to build a custom integration recipe that transforms text between two Text columns on your board between lowercase and uppercase.
Tip: Here is the link to our GitHub repository for this custom integration: https://github.com/mondaycom/welcome-apps/tree/master/apps/quickstart-integrations
In the end it will look similar to this:
Intro to Integration Recipes
All integrations in monday.com have one or more recipes associated with it.
A recipe consists of two parts: a trigger and an action. These are both found in a sentence that ties them together. A trigger is an event that happens either in monday.com or another service. The action is the result of this trigger.
In monday.com, you have the ability to use triggers and actions already in the platform as well as your own custom ones. This provides you with the flexibility to create any workflow you could imagine. A few examples of recipes you can build with integrations are:
- When a lead is created in salesforce > create an item in monday
- When status changes to something > send email to user
- Each time period > create and share report from a board
In this quickstart guide, we'll build a simple integration that automatically manipulates data from a text column into another text column. The app will do the following things:
- Use a monday trigger to notify your app when a column data has changed
- Use a custom action to write the manipulated text to a column value
Tip: Don't have a monday.com account, or need one for testing? Sign up for a free developer account here.
Part 1: Add an integration to your monday app
To add an integration to your monday app, simply click on the "Create Features" section of your app and choose "Integrations."
Next, choose the "Quickstart Integration - NodeJS" template to start. Add in the missing scopes, run the command scaffold in your command line, and paste the resulting URL into the URL box.
Part 2: Update your integration's basic information
In the feature editor, open the "Feature Details" tab. This is where you can add a title and description to your custom integration recipe. The user will see the title and description when they see your recipe in the Integrations Center.
After this step, you should be able to load up the app for the first time using your local tunnel. Pretty exciting!
Part 3: Recipe configuration
Our new feature templates have the integration recipe already set up for you, ready to go.
To see how this integration recipe works, clicking into the recipe itself to see the "Trigger" and "Action" configurations. These have already been implemented for you via the template selection you made!
This integration utilizes a custom action that calls our API to update a second text column. If you're curious to see the code behind this recipe, navigate into the "quickstart-integrations" folder that was downloaded onto your computer after you ran the command line prompt in Part 1.
In short, integrations run off of triggers that invoke certain actions. These triggers are the conditions that are met before an action can take place.
Part 4: Using the custom integration recipe
You're done! Head to any one of your boards to add the integration recipe by searching up its name (in this example the integration name is "New Feature").
Follow the integration recipe prompts as normal (selecting which Text columns you want) and watch the magic unfold!
Read this next
Once you've finished this article, read these to learn more about key concepts: