CustomHttpHeader

Represents a custom HTTP header that provides context information from Salesforce such as region, org details, or the role of the person viewing the external object. This object is available in API version 43.0 and later.

Supported Calls

describeLayout(), describeSObjects(), query(), retrieve()

Special Access Rules

As of Spring ’20 and later, only authenticated internal and external users can access this object.

Fields

Field Name	Details
Description	Type textarea Properties Filter, Nillable, Sort Description A text description of the header field’s purpose.
HeaderFieldName	Type string Properties Filter, Group, Sort Description Name of the header field. The name must contain at least one alphanumeric character or underscore. It can also include: ! # $ % & ' * + - . ^ _ ` \| ~
HeaderFieldValue	Type string Properties Filter, Sort Description A formula that resolves to the value for the header. The values in the formula must evaluate to a string. If the formula resolves to null and an empty string, the header isn’t sent.
IsActive	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the custom HTTP header is available to use.
ParentId	Type reference Properties Filter, Group, Sort Description ID of the entity that the custom HTTP header is related to.

Usage

For each OData external data source, define up 10 HTTP headers to request data.

HTTP headers aren’t supported on named credentials.

Note

Object Reference for Salesforce and Lightning Platform

CustomHttpHeader

Supported Calls

Special Access Rules

Fields

Usage