--- sourceDocument: Yokohama Data and Automation sourceDocumentLink: https://www.servicenow.com/docs/r/yokohama/integrate-applications Release : - yokohama ft:locale : - en-US ft:publication_title : - Yokohama Data and Automation ft:clusterId : - crint bundleId : - crint workflow : - Creator --- # Microsoft Exchange Server Spoke # Microsoft Exchange Server Spoke {#ariaid-title1} * Release version: Yokohama * * Updated April 10, 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 minutes to read The Microsoft Exchange Server spoke creates and manages address list, mailbox, and calendar events in Microsoft Exchange mail system. ## Request apps on the Store {#msexchangeserver-spoke__section_jkg_1ff_mjb} Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the [ServiceNow Store version history release notes](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).{#msexchangeserver-spoke__inline-send-to-store} ## Integration Hub subscription {#msexchangeserver-spoke__section_rsf_yvb_l3b} This spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf). ## Spoke version {#msexchangeserver-spoke__section_kbc_qpw_bsb} Microsoft Exchange Server spoke v2.6.0 is the latest version.{#msexchangeserver-spoke__exchng-serv-ver} ## Spoke dependencies {#msexchangeserver-spoke__section_h4k_ml1_3lb} If you're having trouble installing the app, ensure that these dependent plugins are installed: * ServiceNow IntegrationHub Action Step - PowerShell (com.glide.hub.action_step.powershell) * ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime) {#msexchangeserver-spoke__ul_xpv_nfj_flb} Note: Some of these plugins are licensable features and require an appropriate license if used outside the spoke implementation. For information on licenses, contact your account manager. ## Supported versions {#msexchangeserver-spoke__section_vww_r21_vhb} * Exchange Server 2016 installed on Windows Server 2016 Note: The Create Calendar Event For User and Lookup Room Availability actions are supported only on Exchange Server 2013. * Exchange Server 2013 installed on Windows Server 2012 R2 {#msexchangeserver-spoke__ul_sfk_1f1_vhb}This spoke may be compatible with the earlier versions of Microsoft Exchange Server. ## Spoke requirements {#msexchangeserver-spoke__section_vgj_hh2_b3b} Powershell remoting must be enabled on the target Exchange Server. For more information about the Microsoft Exchange Server, see [Exchange Server documentation](https://docs.microsoft.com/en-us/exchange/exchange-server?view=exchserver-2019). ## Spoke flows {#msexchangeserver-spoke__section_v5s_tjt_wpb} The Exchange Server spoke provides sample flows to demonstrate automating the Exchange Server tasks. To customize a sample flow, copy it to the required application scope. Available sample flows include: {#msexchangeserver-spoke__table_vz3_zjt_wpb__entry__2} | Flow | Description | |-|-| | Pull From Subscriptions | Uses the Look up Items From Subscription ID subflow to periodically retrieve the modified items in an active subscription and saves the details in the ServiceNow instance. | | Look up Calendar Item from Item ID Flow | Uses the Look up Items From Subscription ID subflow to display the details of the modified items in a subscription in the Subscription to Events Mapping module. | | Renew Subscription | Uses the Renew Subscription subflow to renew subscription. | [ ] {#msexchangeserver-spoke__table_vz3_zjt_wpb} Note: Subscriptions are valid for 24 hours and flows renew the subscriptions periodically. If there are failures with the third-party applications, subscriptions will not be renewed. That is, Active is set to False. In the event of failure, you should use the create subscription flow to create a subscription. ## Spoke subflows {#msexchangeserver-spoke__section_wml_jlt_wpb} The Exchange Server spoke provides sample subflows to demonstrate automating the Exchange Server tasks. To customize a sample subflow, copy it to the required application scope. Available sample subflows include:{#msexchangeserver-spoke__table_ymb_llt_wpb__entry__2} | Subflow | Description | |-|-| | Look up Items From Subscription ID | Saves the details of the modified items in a subscription to the Event to Subscription Mapping table. | | Create Subscription | Creates a subscription for the specified mailbox and adds it to the Subscription table. If the subscription already exists, the subflow adds the application details to the subscription record. | | Renew Subscription | Renews a subscription for the given mailbox. | [ ] {#msexchangeserver-spoke__table_ymb_llt_wpb} ## Spoke actions {#msexchangeserver-spoke__section_ffw_wn1_vhb} The Microsoft Exchange Server spoke provides actions to automate address list, mailbox, and calendar event tasks.{#msexchangeserver-spoke__table_rfs_y41_vhb__entry__3} | Category | Action | Description | |-|-|-| | Address List Management | Create Address List Using Included Recipients | Creates a new address list in Exchange Server using the Included Recipients field. | | Address List Management | Create Address List Using Recipient Filter | Creates a new address list in Exchange Server using the Recipient field. | | Address List Management | Delete Address List | Deletes the required address list on a required Exchange Server. | | Address List Management | Get Address List Details | Retrieves the details of a required address list on a required Exchange Server. | | Address List Management | Look Up Address List | Retrieves the address list details on a required Exchange Server using a search query. | | Address List Management | Look up Address List Details | Retrieves details of the specified address list by identity. | | Address List Management | Move Address List | Moves an address list to another location in the address hierarchy. | | Address List Management | Synchronize Address List | Refreshes email clients with the latest details, for a required address list in Exchange Server. | | Address List Management | Update Address List Using Included Recipients | Updates details and recipients of a required address list using a the Included Recipients field. | | Address List Management | Update Address List Using Recipient Filter | Updates details and recipients of a required address list details using the Recipient Filter field. | | Mailbox Management | Create Calendar Event For User | Creates a calendar event in Exchange Server. Calendar event can be either a meeting or appointment. Note: * This action is supported only on Exchange Server 2013. * This action uses the Exchange_https connection and credential alias. {#msexchangeserver-spoke__ul_xjr_gq1_vhb} | | Mailbox Management | Create Mailbox | Creates mailboxes and user accounts simultaneously. | | Mailbox Management | Delete Mailbox | Deletes a mailbox in Exchange Server. | | Mailbox Management | Disable Mailbox | Disables a mailbox in Exchange Server. | | Mailbox Management | Enable Mailbox | Enables a mailbox in Exchange Server. | | Mailbox Management | Look up Calendar by Event ID | Retrieves the list of calendar events. | | Mailbox Management | Look up Mailbox | Retrieves mailbox properties for a given mailbox in Exchange Server. | | Mailbox Management | Look up Room Availability | Retrieves the availability response for a given array of room objects. | | Mailbox Management | Update Mailbox | Updates the properties of a mailbox in Exchange Server. | | Mailbox Management | Set Mailbox Auto Reply | Schedules the auto-reply for a given mailbox in Exchange Server. | | Mailbox Management | Lookup Room Mailboxes | Retrieves all the room mailboxes in Exchange Server. | | Meeting Management | Look up Meeting Suggestions | Retrieves the meeting suggestions for the specified mailboxes. | | Meeting Management | Update a Calendar Meeting | Updates an existing calendar event that has already been created. While updating the meeting, in addition to saving the modified appointment item to the calendar folder, the updated meeting request is sent to all attendees. | | Meeting Management | Look up Meetings Stream | Retrieves details of the user's meetings within the specified start and end times. | | Meeting Management | Look up Folder ID | Retrieves Folder ID of the required folder. | | Meeting Management | Delete Calendar Event for User | Deletes the specified existing calendar event. The update is sent to all attendees. | | Meeting Management | Look up User Availabilities | Retrieves the availability response for a given mailbox. | | Subscription Management Note: The Exchange Server spoke supports the calendar events only. | Create Subscription | Creates a new subscription for given mailbox. | | Subscription Management Note: The Exchange Server spoke supports the calendar events only. | Look up Calendar Item from Item ID | Retrieves the calendar information for the given calendar ID. | | Subscription Management Note: The Exchange Server spoke supports the calendar events only. | Look up Events by Subscription ID | Retrieves the latest changes in the calendar folder for the subscription since the last watermark. | | Attachment Management | Copy Attachment to Event Record | Copies an calendar event's attachment to the specified record in the ServiceNow instance. | | Attachment Management | Create Attachment | Adds attachment to an event. | | Attachment Management | Delete Attachment | Deletes an attachment associated with the provided Attachment ID. | | Attachment Management | Delete Attachments from Event Record | Deletes one or more attachments associated with the specified event record. | | Attachment Management | Look up Attachment by Attachment ID | Retrieves the specified attachment. | [Table 1. Microsoft Exchange Server spoke actions] {#msexchangeserver-spoke__table_rfs_y41_vhb} ## Spoke modules {#msexchangeserver-spoke__section_l3c_2kt_wpb} The Exchange Server spoke adds a Microsoft Exchange Server Spoke module to your ServiceNow instance. Data is these modules is populated when the associated flows are executed:{#msexchangeserver-spoke__table_i1z_lkt_wpb__entry__2} | Module | Description | |-|-| | Subscriptions | Displays details of the subscriptions in Exchange Server. Data is populated in this module when the Create Subscriptions and Renew Subscriptions subflows are executed. | | Events | Displays details of the events in Exchange Server. Data is populated in this module when the Look up Calendar Item from Item ID flow is executed. | | Event Attendees | Displays details of the event attendees in the events. Data is populated in this module when the Look up Calendar Item from Item ID flow is executed. | | Subscription to Events Mapping | Displays details of the subscriptions and events. Data is populated in this module when the Look up Items From Subscription ID subflow is executed. | [ ] {#msexchangeserver-spoke__table_i1z_lkt_wpb} ## Connection and credential alias requirements {#msexchangeserver-spoke__section_s2c_prg_2hb} Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. Two connection and credential aliases are created when the Microsoft Exchange Server spoke is activated, Exchange and Exchange_https. Note: * The Exchange_https alias is supported only on Exchange Server 2013. * The Exchange_https alias is required to use the Create Calendar Event For User and Lookup Room Availability actions. {#msexchangeserver-spoke__ul_upd_kng_vhb} For information about setting up the spoke, see [Set up the Microsoft Exchange Server spoke](https://www.servicenow.com/docs/mwvCg5WKcLNYZR1VDcwqBQ#setup-msexchange "Connect your ServiceNow instance with the Microsoft Exchange Server by setting up the connection and credential records for both the Microsoft Exchange Server that are provided when you install Integration Hub on your instance."). ## MID Server requirements {#msexchangeserver-spoke__section_gsl_trg_2hb} Your instance must have a MID Server set up and configured to run PowerShell 2.0. Use the connection record associated with the Microsoft Exchange alias to configure where actions run as well as set MID Server selection attributes. For more information, see [MID server](https://www.servicenow.com/docs/access?context=mid-server-landing&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). To set up the MID Server for this spoke, see [Set up MID Server for a spoke](https://www.servicenow.com/docs/7UvzwoYZypnKC5tNoxHk4Q "Configure MID Server settings on your ServiceNow instance that enables it to integrate with a third-party application via MID Server after you have set up the connection record for a spoke.").