EventDelivery

Represents how an event instance maps to a target payload. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

Event delivery components have the suffix file path .delivery, and are stored in the eventDeliveries folder.

Version

Event delivery components are available in API version 41.0 and later.

Limits

Your org can have a maximum of 2500 EventDelivery object instances.

Fields

Field Name	Field Type	Description
eventParameters	EventParameterMap[]	An array of parameters to deliver in addition to the published event’s data.
eventSubscription	string	Required. The ID of the subscription to deliver the data to.
referenceData	string	User-defined non-unique identifier.
type	EventDeliveryType (enumeration of type string)	Required. Determines what action occurs when the event is delivered to the listeners on behalf of the subscribers. Valid values are: `StartFlow`—When the event occurs, it’s delivered to a flow of type CustomEvent. Those flows are built through Process Builder. `ResumeFlow`—Reserved for future use.

EventParameterMap

Parameters to deliver in addition to the published event’s data.

If type is StartFlow, you must include a parameter where parameterName is FlowVersionName and parameterValue is the name of the flow that you want to start. The flow name must include its version number. For example, myFlow-3.

Each event delivery can have up to 10 parameters.

Field Name	Field Type	Description
parameterName	string	The parameter name.
parameterValue	string	The parameter value.

Declarative Metadata Sample Definition

The following is an example of an event delivery file.

1<?xml version="1.0" encoding="UTF-8"?>
2<EventDelivery xmlns="http://soap.sforce.com/2006/04/metadata">
3   <eventParameters>
4      <parameterName>FlowVersionName</parameterName>
5      <parameterValue>My_Event_Based_Process-1</parameterValue>
6   </eventParameters>
7   <eventSubscription>MySubscription</eventSubscription>
8   <referenceData>My_Event_Based_Process_1</referenceData>
9   <type>StartFlow</type>
10</EventDelivery>

The following is an example package.xml that deploys or retrieves all the available event delivery metadata in your org.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4      <members>EventDelivery</members>
5      <name>*</name>
6   </types>
7</Package>

Metadata API Developer Guide