Retry Handler Framework

  • Release version: Zurich
  • Updated July 31, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Retry Handler Framework

    The Retry Handler Framework is designed to automatically retry failed HTTP requests when API rate limits are exceeded and the server returns a 429 Too Many Requests status code. It uses theretry-afterHTTP header to determine when to retry the request, ensuring compliance with API rate limiting policies and improving integration reliability.

    Show full answer Show less

    This framework is available exclusively as part of the Microsoft Exchange Online Spoke or the Journey Accelerator app within the ServiceNow ecosystem.

    Key Features

    • Request Retry Management: Handles retrying HTTP requests after the specified retry-after interval to avoid failed calls due to rate limiting.
    • Sample Flows: Provides pre-built flows such as:
      • Renew Subscriptions: Automatically renews subscriptions nearing expiration, excluding those marked as Being Deleted.
      • Clean up Queue Records: Removes processed or stale records from the Request Retry Queue based on criteria like state and last updated time.
      • Scheduled Job: Processes queued retry requests systematically.
    • Sample Subflows: Offers reusable subflows to automate common Journey Accelerator tasks, including:
      • Calendar Synchronization: Syncs Exchange Online calendar events with ServiceNow tables, creating or validating subscriptions as needed.
      • Create or Update Subscription Record: Manages webhook subscriptions by creating or updating them in Microsoft Exchange Online.
      • Delete Calendar Scheduling Event: Removes specific calendar events and all associated records from ServiceNow and Exchange Online.
      • Event Lifecycle Management: Maintains event and attendee data consistency across systems.
      • Attachment and Event Detail Management: Retrieves and updates event attachments and details from Exchange Online.
      • Subscription Lifecycle Management: Demonstrates event and webhook subscription management, including creation and renewal.
      • Sync up Events: Synchronizes calendar views and handles missed lifecycle notifications.
      • Update Calendar Scheduling Event: Updates event properties in both ServiceNow and Exchange Online.

    Practical Considerations for ServiceNow Customers

    • The Retry Handler Framework helps maintain robust integrations with Microsoft Exchange Online by gracefully handling API rate limits and ensuring data synchronization.
    • Sample flows and subflows can be customized by copying them into a new application scope, enabling tailored automation workflows.
    • Before using synchronization subflows, customers must ensure that the relevant data tables (such as Exchange Online Calendar Events Transformed Data) are properly populated and maintained.
    • Some subflows are hidden from the subflow picker because they serve as internal components within larger workflows.
    • Installation of the Journey Accelerator app or Microsoft Exchange Online spoke is required to use the Retry Handler Framework.

    Framework that retries a failed HTTP request when the API rate limits are exceeded and the 429 Too Many Requests status code is returned. The retry-after time HTTP header is used to retry the request again after that specified retry-after time.

    Request apps on the Store

    Visit the ServiceNow Store 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.

    Spoke requirements

    Note:
    The Retry Handler Framework app is available only as a part of Microsoft Exchange Online Spoke or Journey Accelerator app.
    • Install Journey Accelerator app
    • Microsoft Exchange Online spoke

    Spoke flows

    The Retry Handler Framework provides sample flows to demonstrate automating the Journey Accelerator tasks. To customize a sample flow, copy it to a new application scope. Available sample flows include:

    Flow Description
    Renew Subscriptions Retrieves all the subscription records and renews the subscriptions that are about to expire.
    Note:
    Subscriptions that have Being Deleted as status, will not be considered for renewal.
    Clean up Queue Records Removes the records from Request Retry Queue based on state, execution status, and last updated time.
    Scheduled Job Processes records from the Request Retry Queue table.

    Spoke subflows

    The Retry Handler Framework provides sample subflows to demonstrate automating Journey Accelerator tasks. To customize a sample subflow, copy it to a new application scope. Available sample subflows include:

    Subflow Description
    Calendar Synchronization Retrieves the events from Exchange Online Calendar Events Transformed Data table and updates the events in Microsoft Exchange Online Events table. Checks if a valid subscription exists. Creates a subscription if the subscription does not exist.
    Note:
    You must update the required details in the Exchange Online Calendar Events Transformed Data table before synchronizing events data.
    Create or Update Subscription Record Checks if a subscription with the specified details exists in Microsoft Exchange Online. If the subscription exists, then the subscription record is updated. Otherwise, a subscription is created in Microsoft Exchange Online and an associated record is created.
    Delete Calendar Scheduling Event Deletes the specified event in Microsoft Exchange Online and the associated record from events tables, attachments, records from event attendees and event to subscription m2m tables.
    Event Lifecycle Management Retrieves the event details and updates the record details of the event, attendees, and event to subscription m2m tables.
    Look up and Update Attachments to Event Record Retrieves the specified event's attachments from Microsoft Exchange Online and updates the retrieved details to the specified event's record.
    Look up and Update Calendar Scheduling Change Retrieves the event details from Microsoft Exchange Online and updates the details to the specified event's record. If a subscription already does not exist, this subflow creates a subscription and links it with the event record. If an event does not exist in Microsoft Exchange Online, all the related local records are deleted.
    Look up Calendar Details Retrieves the calendar details.
    Note:
    This subflow cannot be reused as it is a part of the Event Lifecycle Management subflow.
    Look up Event Details Retrieves the event details.
    Note:
    This subflow cannot be reused as it is a part of the Update Calendar Scheduling Event subflow.
    Recreate Removed Subscription Recreates a removed webhook subscription using the details from the associated subscription record.
    Renew Subscription Renews a webhook subscription if a renewal is required based on the specified inputs.
    Subscription Lifecycle Management Demonstrates the process of subscription management for webhook subscriptions. This subflow creates an event and checks if a webhook subscription exists. If a webhook subscription does not exist, the subflow creates a webhook subscription, event, attendees, event to subscription m2m table records.
    Sync up Events Syncs the calendar view with the Exchange Online Calendar Events Transformed Data table. Use this subflow to manage missed life-cycle notifications for subscriptions.
    Note:
    You must update the Exchange Online Calendar Events Transformed Data table with the required information before syncing events data.
    Update Calendar Scheduling Event Updates the properties of an event object in Microsoft Exchange Online and the associated records in the events table.
    Note:
    Look up and Update Attachments to Event Record, Look up Calendar Details, Look up Event Details, Renew Subscription subflows are hidden from subflow picker.