Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
EventDelivery
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 versions 41.0 to 45.0.
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.
|
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.
<?xml version="1.0" encoding="UTF-8"?>
<EventDelivery xmlns="http://soap.sforce.com/2006/04/metadata">
<eventParameters>
<parameterName>FlowVersionName</parameterName>
<parameterValue>My_Event_Based_Process-1</parameterValue>
</eventParameters>
<eventSubscription>MySubscription</eventSubscription>
<referenceData>My_Event_Based_Process_1</referenceData>
<type>StartFlow</type>
</EventDelivery>The following is an example package.xml that deploys or retrieves all the available event delivery metadata in your org.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>EventDelivery</members>
<name>*</name>
</types>
</Package>Wildcard Support in the Manifest File
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.