---
schema_version: "1"
id: a0b05b95685f49a526bc61440ae1a3247323e5815f8f7105e9695931723a4efc
title: RealTimeEventSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_realtimeeventsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_realtimeeventsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 56cdbc451878571f2ade1e2b835ef0262890344af5e739fd697dfbd4573bb321
description: Represents the list of Real-Time Event entities that you want to enable or disable. This type extends the Metadata metadata type and inherits its fullName field.
---
# RealTimeEventSettings

Represents the list of Real-Time Event entities that you want to enable or disable. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

Real-Time Event settings are stored in a single file named RealTimeEvent.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

RealTimeEventSettings is available in API version 50.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| realTimeEvents | [RealTimeEvent](#RealTimeEvent)\[\] | Represents the list of Real-Time Event entities that you want to enable or disable. |

## RealTimeEvent

Represents one of the Real-Time Event entities that you want to enable or disable.

| Field Name | Field Type | Description |
| --- | --- | --- |
| entityName | string | The storage or streaming entity name that you want to modify. For example: ApiEvent or ApiEventStream. |
| isEnabled | boolean | Indicates whether you want the storage or streaming capability to be enabled (true) or disabled (false). |

## Declarative Metadata Sample Definition

The following is an example RealTimeEvent.settings metadata file:

<?xml version=“1.0” encoding=“UTF-8"?>
<RealTimeEventSettings xmlns=“http://soap.sforce.com/2006/04/metadata”/>
  <realTimeEvents\>
    <entityName\>ApiEventStream</entityName\>
    <isEnabled\>true</isEnabled\>
  </realTimeEvents\>
  <realTimeEvents\>
    <entityName\>ApiEvent</entityName\>
    <isEnabled\>true</isEnabled\>
  </realTimeEvents\>
</RealTimeEventSettings\>

The following is an example package.xml manifest that references the RealTimeEventSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>RealTimeEvent</members\>
        <name\>Settings</name\>
    </types\>
    <version\>51.0</version\>
</Package\>

## Wildcard Support in the Manifest File

The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). 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).