---
schema_version: "1"
id: daacab59c689078a975d31f9648f1988739631a1504fd4288a57b0a1d3c69376
title: EventDelivery
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_eventdelivery.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventdelivery.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4dbae9a192a8df8cd5f13eb1f5fd7ce82e3b984c393f3cc6563436a65ab8c90c
description: Represents how an event instance maps to a target payload. Removed in API version 46.0. This type extends the Metadata metadata type and inherits its fullName field.
---
# EventDelivery

Represents how an event instance maps to a target payload. Removed in API version 46.0. 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 versions 41.0 to 45.0.

## Limits

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

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d441604e93">Field Name</th>

              <th class="featureTableHeader  " id="d441604e96">Field Type</th>

              <th class="featureTableHeader  " id="d441604e99">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">eventParameters</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">
                <a class="xref" href="#SubTypeID">EventParameterMap</a>[]
              </td>

              <td class="entry" headers="d441604e99" data-title="Description">An array of parameters to deliver in addition to the published event’s
                data.</td>

            </tr>

            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">eventSubscription</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">string</td>

              <td class="entry" headers="d441604e99" data-title="Description"><span class="ph" id="eventSubscription_desc"><a name="eventSubscription_desc"><!-- --></a>Required. The ID of the subscription to deliver
                  the data to. </span></td>

            </tr>

            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">referenceData</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">string</td>

              <td class="entry" headers="d441604e99" data-title="Description"><span class="ph" id="referenceData_desc"><a name="referenceData_desc"><!-- --></a>User-defined non-unique identifier.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d441604e93" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d441604e96" data-title="Field Type">EventDeliveryType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d441604e99" data-title="Description">
                <span class="ph" id="type_desc1"><a name="type_desc1"><!-- --></a>Required. Determines what action occurs when the event is
                  delivered to the listeners on behalf of the subscribers.</span>
                <p class="p" id="type_values"><a name="type_values"><!-- --></a>Valid values are:</p>

                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">StartFlow</samp>—When the event occurs,
                    it’s delivered to a flow of type CustomEvent. Those flows are built through
                    Process Builder.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ResumeFlow</samp>—Reserved for future
                    use.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).