Newer Version Available

This content describes an older version of this product. View Latest

EventDelivery

Represents how an event instance maps to a target payload. Available in API version 41.0 and later.

Supported SOAP Calls

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

Supported REST HTTP Methods

GET, POST, PUT, PATCH, HEAD

Fields

Field Details
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer’s internal name for the event delivery used in the API.
EventSubscriptionId
Type
reference
Properties
Filter, Group, Sort
Description
Required. The ID of the subscription to deliver the data to.
FullName
Type
string
Properties
Create, GroupGroup, Nillable
Description
The unique name used as the event delivery identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
Language
Type
picklist
Properties
Defaulted on create, Filter, GroupGroup, Nillable, Restricted picklist, Sort,
Description
The language of the MasterLabel.
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
  • installed
  • released
  • unmanaged

For more information about states of manageability for components in Force.com AppExchange packages, see “Planning the Release of Managed Packages” in the Salesforce online help.

MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Master label for the event delivery. This internal label doesn’t get translated.
Metadata
Type
mns:EventDelivery
Properties
Create, Nillable, Update
Description
The event delivery’s 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.

NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
ReferenceData
Type
string
Properties
Filter, Group, Nillable, Sort
Description
User-defined non-unique identifier.
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
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.