Skip to main content

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

registerHeader(name, value)

Updated on July 20, 2021

Registers the specified external header to service-broker fetch calls.

Note: You must update to Pega 8.7.3 or later patches to be able to use this API.


A Boolean value that indicates if the external header has been registered to service-broker fetch calls.

  • If the specified external header already exists, the Boolean value false is returned.
  • If the specified external header is registered successfully, the Boolean value true is returned.


namestringThe name of the external header that must be registered to service-broker fetch calls.
valuestringThe value corresponding to the specified external header.

Usage example

In this example, the API registers the external header with the name abc and value xyz to service-broker fetch calls and returns the Boolean value true.

PCore.getRestClient().getHeaderProcessor().registerHeader("abc", "xyz");

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