Pega Digital Experience (DX) API

Future-proof your multiexperience application development.

What is the Pega DX API?

Customers expect a consistent, branded experience across channels. The Pega Digital Experience (DX) API is a set of model-driven API endpoints that enable developers to view, create, and update Pega cases and assignments remotely. The DX API allows developers to build custom front-end experiences for Pega applications without encoding business logic into each and every channel. 

How to Get Started

DX API Starter Packs

The fastest way to get started building custom front-ends with the DX API. All Starter Packs include a DX API interpreter and pre-built example portals & components.

Click a logo below to access the starter pack:

Frequently Asked Questions

Open Accordion Close Accordion

The UX information provided in the API response can be used to create and render front-ends and custom experiences for interacting with Pega applications. Developers can use the DX API to create composite, personalized experiences across channels to:

  • Embed tables within remote interfaces (e.g. display an employee a list of open assignments from Pega in an existing intranet site).
  • Embed forms within remote interfaces (e.g. allow customers to create a new mortgage application in Pega from within the bank’s mobile application).
  • Embed case information within remote interfaces (e.g. display the status of a shipping order tracked in an Operations Pega app within a Pega Customer Service app).
Open Accordion Close Accordion

We recommend developers utilize Pega Mashup for composite experiences and front-ends where possible. Traditional Pega Mashup embeds Pega UI directly into existing interfaces via iFrame –this is set up and configured from application Channels in App Studio.  Traditional Mashups are also model-driven, and will instantly reflect microjourney changes.  Because they use complete Pega UI, they support all of the client-side actions and logic that are available in web portals generated for Pega apps (conditionals, visibility, validation, etc.). More on Pega Mashup here.

DX API can be used by those with front-end expertise when a use case calls for more flexibility and customization than Pega Mashup can provide.

Open Accordion Close Accordion

Most Pega applications and capabilities built on Pega 8.2 and above will be available using the DX API. There are some unsupported capabilities - such as client-side UI logic, like cascading dropdowns and conditional visibility.

Open Accordion Close Accordion

The difference between traditional API’s and the DX API, is that the DX API returns case or assignment UX information in the API response – including information on UI elements, layout, actions, and styling - which can be used to build dynamic, future-proof front-ends

To ask questions, start discussions and share ideas about the DX API, visit the Pega Collaboration Center.