Contact Us 1-800-596-4880

Create a Mule Application Quickly from a Template

The easiest way to get started in Flow Designer is to use a template. A template is a pre-built integration that you can customize. Go to Anypoint Exchange to see templates for the most popular integration use cases. You can open templates in read-only mode in Flow Designer and review them. If you believe that a template will help you create the Mule application that you need, you can create a new project from it, customize the project, and then test and deploy your application.


  1. In Exchange, locate a template that you want to use.

    1. Under All assets on the left side of the screen, click Provided by MuleSoft.

    2. Select Templates in the drop-down list to the left of the search bar.

    3. Search on a term to filter the list of templates.

    4. Click on a template to see details about it. The details include:

      • An overview of what the template does

      • A list of prerequisites for using it

      • A list of steps for configuring it

    5. Look for the option Open flow in the top-right corner of the details page. The presence of this button indicates that the template is compatible with Flow Designer. If the only option is Download, then the template is compatible only with Anypoint Studio.

  2. Click Open flow.

    Result: The template is opened in read-only mode in Flow Designer. Read-only mode lets you find out which connectors and operations are used, how data changes as it moves through the flow, and what configurations for connecting to your systems are already set up.

  3. If you think the template will suit your needs, click Use this template in the top-right corner of Flow Designer.

    Result: A dialog box asks you to name the new project based on the template and to select the environment to create it in. After you click Create, the project is opened in edit mode. Red dots above the cards indicate places where you have to fill in fields before you can run the application. For example, you must provide credentials for authenticating to systems that are represented by cards.

  4. Provide the required information.

    1. Click the Problems tab at the bottom of the screen to see the list of problems.

    2. Click a problem in the list to be taken to a place in the application where you must provide information. For guidance about what information you need to provide in a card, refer to the notes for that card by clicking the Notes tab.

    3. Continue down the list of problems until none remain.

    Result: All of the red dots that were above the cards should now be gone. At this point, you could run the application. However, you might first need to customize it for your particular use case. You can do that in the next step. For example, if a flow has a card for the Slack connector and posts a message to a Slack channel, you would need to provide the message. Also, the default name of the channel is general. You might need to change that name to match the name of the actual channel that you want the flow to post to.

  5. Open each card, review the values in its fields, and customize any values that you might need to for your use case.

    For guidance while you are customizing, refer to the Notes section in each card.

  6. When you are ready, click Run to run the application temporarily and test it. While an application is running, you can trigger its flows and verify that data moves through the flows correctly. After you click Run, the application continues to run for 60 hours unless you make changes to it. Whenever you make a change, the application stops running.

  7. When you are satisfied with the application, click the Deploy button to run the application in a sandbox environment or in a production environment.