EventSubscription

Represents a subscription to an event type. Removed in API version 46.0. Available in API version 41.0 to 45.0.

Supported SOAP Calls

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

Supported REST HTTP Methods

GET, POST, PUT, PATCH, HEAD

Fields

Field Details
Active
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If the subscription isn’t active, it never receives any events.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer’s internal name for the event delivery used in the API.

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

Note

EventType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The type of event to subscribe to. Valid values are:
  • AlarmEvent—An alarm that’s offset from an absolute time (supported only if the EventDelivery type is ResumeFlow)
  • CustomEvent—Reserved for future use
  • DateRefAlarmEvent—An alarm that’s offset from a date/time field value (supported only if the EventDelivery type is ResumeFlow)
  • EventObject—A custom platform event
  • StandardPlatformEvent—A standard platform event
FullName
Type
string
Properties
Create, Group, 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, Group, 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
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Master label for the event subscription. This internal label doesn’t get translated.
Metadata
Type
mns:EventSubscription
Properties
Create, Nillable, Update
Description
The event subscription’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 that is associated with this object. Each Developer Edition org 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 orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless 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 org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
ReferenceData
Type
string
Properties
Filter, Group, Sort
Description
If the subscriber is a flow of type CustomEvent, referenceData is flowName_versionNumber. For example, Printer_Management_2.