Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

WorkflowOutboundMessage

Represents an outbound message. An outbound message sends information to a designated endpoint, like an external service. Outbound messages are configured from Setup. You must configure the external endpoint and create a listener for the messages using the SOAP API.

This object is available in API version 32.0 and later.

Supported SOAP Calls

create(), delete(), query(), retrieve(), search(), update(), upsert()

Supported REST HTTP Methods

DELETE, GET, PATCH, POST

Fields

Field	Details
ApiVersion	Type double Properties Filter, Sort Description The API version is automatically generated and set to the current API version when the outbound message was created.
EntityDefinition	Type EntityDefinition Properties Filter, Group, Sort. Description Required. Available in version 34.0. The entity definition for the object associated with this WebLink.
EntityDefinitionId	Type string Properties Filter, Group, Sort Description The ID of the entity containing the outbound message.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated metadata object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IntegrationUserId	Type ID Properties Filter, Group, Sort Description The ID of the user under which this message is sent.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
Metadata	Type `mns:`WorkflowOutboundMessage Properties Create, Nillable, Update Description Outbound message definition metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Name	Type string Properties Filter, Group, idLookup, Sort Description The name of the outbound message.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace of the package containing the outbound message.

Tooling API

WorkflowOutboundMessage

Supported SOAP Calls

Supported REST HTTP Methods

Fields