Skip to main content

Table of Contents

Using real-time container APIs


Only available versions of this content are shown in the dropdown

This section provides information on the APIs available for use with Real-Time Containers.

When invoked, each API sets one of the following HTTP status codes in its response:

  • 200 - Successful invocation
  • 400 - Bad request
  • 500 - Internal error
  • Triggering a real-time container with the Container REST service

    The Container service is available to make a Next-Best-Action decision in inbound, real-time channels such as web self-service, call center and mobile applications. The Container REST API supports both the POST and GET HTTP methods. The Container service provides a layer of abstraction between the calling channel and the specific decision logic that is executed so a user can easily change the content delivered to the channel without changing the interface or parameters in the API.

  • Making custom Strategy Result properties available for real-time container data flows

    Now that you have passed in Context data as part of the Container request, you will want to access this data within your decision strategies. There are two utility functions that allow you to access this data depending on your requirements.

  • Capturing responses to actions triggered by a real-time container

    CaptureResponse is a REST service that supports the POST HTTP method. This service allows callers to capture responses to actions triggered via Real-Time Containers.

  • Accessing a customer's interaction history with the CustomerOfferHistory REST service

    CustomerOfferHistory is a REST service that supports both GET and POST HTTP methods. This service returns the Interaction History records for a customer.

  • Capturing clicks on the click-through URL

    CaptureClickThrough is a REST service that allows callers to request the handling of a click on the Container for an authenticated channel. This service records a click in IH before redirecting to the requested URL. Based on the Container's configuration, this service may also initiate the specified action for the customer.

Did you find this content helpful?

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us