EventSettings Metadata Architecture Guide

Architectural Overview#

EventSettings is a core settings metadata type that configures calendar management, scheduling automation, and meeting collaboration across Salesforce. In sales and service operations, events bridge CRM records with real-world customer touchpoints.

This metadata type controls global calendar behaviors—such as enabling recurring events, permitting multiday calendar entries, and determining whether Salesforce sends iCalendar meeting invites when users schedule appointments with Contacts or Leads. Managing these settings in source code ensures parity between developer environments, sandboxes, and production orgs.

Directory and File Conventions#

EventSettings belongs to the Settings metadata category and is stored within the settings directory using the member name Event.

Key Metadata Fields#

The EventSettings XML schema defines configuration toggles for calendar scheduling:

Declarative XML and Package Manifest Examples#

Below is a declarative XML definition configuring calendar scheduling capabilities:

<?xml version="1.0" encoding="UTF-8"?>
<EventSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableDeleteMultiDayEvents>true</enableDeleteMultiDayEvents>
    <enableEventAttendeeInvitations>true</enableEventAttendeeInvitations>
    <enableMultidayEvents>true</enableMultidayEvents>
    <enableRecurringEvents>true</enableRecurringEvents>
</EventSettings>

Manifest Definition (package.xml)#

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

CLI Retrieval and Deployment Commands#

Retrieve and deploy with sf CLI commands:

# Retrieve Event settings
sf project retrieve start --metadata Settings:Event

# Deploy Event settings
sf project deploy start --metadata Settings:Event

Architect Best Practices and Gotchas#

• Invitation Deliverability: When enableEventAttendeeInvitations is set to true, ensure Salesforce Email Deliverability is configured to “All Email” in sandboxes, or calendar invitations will be suppressed.
• Integration Interactions: If your organization uses Einstein Activity Capture or third-party sync engines (such as Riva or Groove), align enableRecurringEvents with your integration engine capabilities to avoid duplicate meeting artifacts.
• Page Layout Dependencies: When enabling recurring events, verify that the IsRecurrence and recurrence frequency fields are exposed on Event Layout definitions.

Frequently asked questions

What does EventSettings control in Salesforce?

It controls calendar and event behaviors including recurring events, attendee invitation emails, multiday events, and meeting synchronization.

How is EventSettings retrieved via Salesforce CLI?

Retrieve it using sf project retrieve start with metadata Settings:Event or declare Event under the Settings type in package.xml.

Does EventSettings affect Einstein Activity Capture?

Yes. EventSettings governs foundational calendar features that feed into Einstein Activity Capture and Outlook or Google calendar integrations.