Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Connect REST rules

Updated on April 6, 2022

Connect REST rules support interactions between the Pega Platform and other systems over the Hypertext Transfer Protocol (HTTP).

Use REST connector rules in an application to leverage the Representational State Transfer (REST) architectural style for consuming information exposed by RESTful web services. REST services typically present this data as JSON (JavaScript Object Notation) or XML types.

A Connect REST rule is an instance of the Rule-Connect-REST rule type. Connect REST rules belong to the Integration-Connectors category.

Connect REST rules can be referenced in an Integrator shape of a flow rule, or on the Definition tab of a Data Page rule, as the source of data for the contents of the data page.

The REST connector supports sending and receiving attachments with the HTTP response message. For information about how to handle attachments, see File attachment configuration in REST and SOAP integrations.

To list the Connect REST rules in your application, use the Application Explorer or click ConfigureIntegrationConnector Definitions & Simulations.

To list all Connect REST rules that are available to you, use the Records Explorer.

  • Creating a Connect REST rule

    Create a Connect REST rule and identify the external system with which this connector rule communicates.

  • Mapping the request and response data for Connect REST rules

    Use the Methods tab to map the data for the request and from the response for each of the HTTP methods that are allowed for this particular resource.

  • Connect REST calling activity

    A REST connector is called by an activity with the Activity type set to Connect that applies to a class derived from the Work- base class. Such activities can be referenced in an Integrator shape in a flow rule.

  • Asynchronous execution by the Pega-IntScvs agents

    To perform REST connector processing asynchronously:

  • Working with SSL-enabled endpoints

    When a customer has a Connector rule for an HTTP-based protocol such as HTTP, SOAP, REST, and sometimes Email, they may point to an SSL-enabled ("https") endpoint. The service that is connected to will provide an SSL certificate in order to identify itself and secure the connection.

  • JSON mapping for special characters
  • Connector parameters in data pages

    You can specify parameters in connectors to define the contract for calling the connector from a data page. When you configure a data page with a connector data source, you can provide values for the parameters that you define in the connector, and pass them to the data page. By defining parameters in a connector, you help users understand what inputs the connector expects.

  • Endpoint configuration upgrade

    Take advantage of all available configuration options for a URL by upgrading a REST connector to the new endpoint configuration. Use the Upgrade to new endpoint configuration button to upgrade a REST connector that was made before Pega Platform 8.3.

  • Troubleshooting REST connectors

    Learn how to diagnose and troubleshoot issues in REST integrations.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us