Connecting Pigment To Your Mulesoft Flows

  • 27 February 2023
  • 0 replies

Userlevel 3
Badge +1

Table of Contents



Mulesoft is a leading ETL provider that allows users to extract and load data from multiple sources into and from services such as Pigment. The guide below outlines how you can implement Pigment API calls into Mulesoft using their default HTTP module.


Use Cases

You can use the Pigment connection in Mulesoft to:

  1. Import data from sources such as an ERP or HR system to Pigment for analysis.
    Example: Export revenue data from SAP for analysis and forecasting into Pigment.
  2. Export data from Pigment back into other sources for reporting and data parity.
    Example: Return completed hiring approvals into Workday and create a hiring record.

Obtaining Your API Information

In order to use Pigment within your Mule Flows, you will need to obtain the following information:

For imports:

  1. An import API Key
  2. A configuration ID

Detailed steps on how to obtain this information is available here.

For exports:

  1. An export API key
  2. An application ID
  3. A view ID

Detailed steps on how to obtain this information is available here.

Using The Sample File

Pigment provides a sample JAR file available here.

Use this as a starting point for your Mulesoft workflows, or to gain an understanding of how to set up the request connector with Pigment’s API.

Use of the JAR file is completely optional and we have included setup instructions below should you wish to set up a Flow without it.

To import this file into Anypoint Studio:

  1. Select File > Import…

  2. Type jar into the import window.

  3. Select Packaged Mule Application (.jar) then Next


  4. Select the JAR file from its location on your computer.

  5. Provide a project name of your choosing, then select Next. It will load into your Anypoint Studio workspace, where you will find three example Mule Flows.



Each Mule Flow represents a separate API call possible with the Pigment service:

  1. Import service
  2. Export metrics and tables
  3. Export transaction lists

To customise the samples with your own information, edit the file under the src/main/resources folder using the details in the obtaining your API information section.

A full list of attributes to edit are below:

  1. import.config
  5. import.api.key
  6. export.api.key
  7. working.dir

ℹ️ You only need to configure the attributes according to the flow(s) you want to use. Feel free to discard any unused variables and flows.


Configuring The Request Module

Communication to the Pigment service is achieved through using the Request Module which is a standard component within Anypoint Studio.

  1. Using the Mule Palette, drag a Request module onto the message flow section.

  2. Click on the newly added request and navigate to the settings panel and check you’re in the general tab.

  3. In the Configuration field, press the green plus button to create a new HTTP request configuration.

  4. In the resulting window, set the following values:0
    Protocol: HTTPS
    Port: 443


  5. Leave the rest as defaults and save.

  6. Back in the settings/general panel, set the following:

    Method: GET or POST, depending on your required functionality.

    Path: The URL path for your required functionality.

    Note: Omit the portion as that is configured in the host mentioned above.

    You will also need to add variables to the URL depending on the method chosen, such as the application ID or the config ID.

    Headers: Add the name “X-Pigment-Api-Key” with the value being your pigment API key.

ℹ️ To understand the correct values for your chosen API method, please refer to the Pigment API documentation:

  1. Import API
  2. Export API

ℹ️ You can also use a properties file and use referenced attributes instead of hard-coding values such as API keys and config IDs. Please refer to the Mulesoft documentation here for further information.


Your setup is now complete. You’re free to use the request module within any Mule Flow!

This topic has been closed for comments