---
schema_version: "1"
id: c64ec51baf793fa2677481cc1ec9bf49040577e2c49a7c29d93d29c0de1a3f03
title: Rest Consumer Connector Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/composer-salesforce/ms_composer_rest_consumer_reference.md
canonical_url: https://docs.mulesoft.com/composer-salesforce/ms_composer_rest_consumer_reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: fc1fc782d6061ee97c4267b829cfb508ca46869409de72be88b6603cd222045e
description: MuleSoft Documentation Site
latest: true
---
---
product: Composer for Salesforce
---

# Rest Consumer Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Rest Consumer Connector connects externally available APIs managed in Anypoint that are not
currently supported through dedicated connectors. Use Rest Consumer Connector to consume these APIs
in a Composer flow to create integrations that span beyond out-of-the-box connectors.

Rest Consumer Connector does not automatically appear in the list of connectors to use in your flow.
To use Rest Consumer Connector, you must first connect your Composer org to your Anypoint org. For
more information, refer to
[Connect Composer to Anypoint Platform](https://docs.mulesoft.com/composer-salesforce/ms_composer_prerequisites#connect-composer-to-anypoint-platform)
and [API Sharing](https://docs.mulesoft.com/composer-salesforce/ms_composer_prerequisites#api-sharing).

## Connections

To connect to a system, whether it is a source of data or the target where you are sending data, you
must create a connection with that system’s required credentials. You typically connect to different
systems within a flow and can reuse each connection every time you need to connect.

This system requires the following credential information for its connections:

Connection Display Name

Enter a connection name that will help you remember the details of this connection. You can reuse
connections multiple times in a single flow, and in more than one flow, and the credentials are
hidden after you create the connection. Therefore, it’s helpful to provide a name that easily
identifies this connection from others.

Only you can see the connection. Other users in your Composer app must create their own connections.

Authorization Type

The following authorization types are available:

- **API Key**  
  The API Key connects to applications without explicitly defining a user. You must add this key to
  all requests, and the cloud application identifies the origin of the request and completes the
  authorization. Provide a value for the following fields:

  - **Base URL**

  - **Name**

  - **Value**

  - **Sent As**: Select one of the following values:

    - **Header**: If selected, Composer adds the following header to the request: `Name: Value`.

    - **Query Parameter**: If selected, Composer adds the following query parameter to the request:
      `Name=Value`.

  - **Client ID**: This field is used for gateway authentication, which occurs before connected API
    authentication.

  - **Client Secret**: This field is used for gateway authentication, which occurs before connected
    API authentication.

- **Basic Authentication**  
  The Basic Authentication method enables an HTTP user agent to provide a username and password when
  making an HTTP request. Provide a value for the following fields:

  - **Base URL**

  - **Username**

  - **Password**

  - **Client ID**: This field is used for gateway authentication, which occurs before connected API
    authentication.

  - **Client Secret**: This field is used for gateway authentication, which occurs before connected
    API authentication.

- **Bearer Token Authorization**  
  Bearer Token Authorization is the authentication process that sends a header named `Authorization`
  with a value of `Bearer` and a token with every request. Provide a value for the following fields:

  - **Base URL**

  - **Token**

  - **Client ID**: This field is used for gateway authentication, which occurs before connected API
    authentication.

  - **Client Secret**: This field is used for gateway authentication, which occurs before connected
    API authentication.

Base URL

The default location URL for the cloud application that the connection uses.

## Actions

After you connect to a system and define the trigger or configure a scheduler, you define the
actions that the flow performs. For example, you can copy a record between different systems, such
as Workday and Salesforce. The actions you can perform depend on which system you are connected to.

This system provides the following actions:

Request

When **Request** is selected in the **Action** field, a request in Rest Consumer returns the fields
of the response payload. A value is required for the following fields:

- **Action**

- **Operation**

- **Input Fields**: You can select from a static list or use a dynamic list from a data pill based
  on the previous step.

  - Optionally, if you click **URI Params**, provide a value for the **Ticket** field.

  - Optionally, if you click **Additional Headers**, provide a value for the following fields:

    - **Key**

    - **Value**

  - Optionally, if you click **Additional Query Parameters**, provide a value for the following
    fields:

    - **Key**

    - **Value**

- **Custom Request Body**: This field is used for overriding the structure of the request body from
  the API specification.

- **Custom Response Body**: This field is used for overriding the structure of the response body
  from the API specification.

## See Also

- [Mulesoft Composer for Salesforce: Overview](https://docs.mulesoft.com/composer-salesforce/ms_composer_overview)

- [MuleSoft Composer for Salesforce: Getting Started](https://docs.mulesoft.com/composer-salesforce/ms_composer_prerequisites)

- [Composer Connector Reference](https://docs.mulesoft.com/composer-salesforce/ms_composer_reference)

- [Knowledge Articles](https://help.salesforce.com/s/)
