Building spokes using Spoke Generator

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 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 Building spokes using Spoke Generator

    The Spoke Generator allows ServiceNow customers to automate integration tasks by creating reusable actions, known as spokes, for custom integrations. This functionality simplifies the integration process with third-party applications without needing extensive scripting knowledge.

    Show full answer Show less

    Key Features

    • Integration Capabilities: Supports both inbound and outbound integrations with third-party applications.
    • OpenAPI Specification: Enables building custom spokes by importing OpenAPI Specifications or creating them manually.
    • User Roles: Different user roles (admin, actiondesigner, fdreadactions) have varying permissions for viewing, creating, and managing spokes and actions.
    • Size and Limitations: Supports importing OpenAPI Specifications up to 10 MB by default, with the option to increase this to 100 MB. There are limitations on the OpenAPI components and the maximum number of operations supported (default 500, configurable up to 1000).

    Key Outcomes

    Implementing the Spoke Generator allows for efficient and powerful integration with third-party applications. This leads to quicker development times for custom integrations, enhanced functionality within ServiceNow, and the ability to manage integration tasks more effectively, ultimately improving overall workflow and productivity.

    Automate integration tasks by creating a sequence of reusable actions to develop custom integrations called spokes.

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps, for information about submitting requests to the store, and to download and install Spoke Generator (sn_spoke_builder). For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    App dependencies

    If you’re having trouble installing the app, ensure that the dependent plugin, ServiceNow IntegrationHub Professional Pack Installer (com.glide.hub.integrations.professional) is installed.

    Note:
    Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.

    Capabilities

    An Integration Hub custom spoke provides both inbound and outbound integration with third-party applications. These integrations, referred to as spokes, are easy to configure and enable you to quickly add powerful actions without the need to write a script. This feature requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

    You can build custom spokes for the required third-party application by importing an OpenAPI Specification or creating a spoke manually.

    Required user roles

    • Users with the admin role can:
      • View the Spokes tab.
      • Create a new spoke.
      • Import an OpenAPI Specification.
      • Create connection alias.
      • Publish actions and save actions as drafts.
      • See spoke activity log.
    • Users with the action_designer and fd_read_actions roles can:
      • View the Spokes tab.
      • See actions in a spoke.
    • Users with the action_designer role can add actions manually.
      Note:
      Users with just the fd_read_actions role can only see actions.
    • Users with the flow_operator or flow_designer can view flows and subflows.

    OpenAPI Specification size limit

    By default, the system can import OpenAPI Specifications up to 10 MB. To increase the import size, update the glide.rest.openapi.max_request_size system property. The maximum value is 100 MB.

    Limitations of OpenAPI Specification

    Spoke actions created by importing OpenAPI specification, contain the OpenAPI step. Ensure that you are aware of these OpenAPI step limitations.

    Request body media types
    The request body only supports JSON media types.
    Note:
    A string type output object is created when the OpenAPI schema has additionalProperties or no properties.
    OpenAPI 3.0 components

    OpenAPI 3.0 adds new components to Swagger 2.0 to describe an API in further detail. OpenAPI support in the OpenAPI step supports some, but not all of these components. The OpenAPI step does not currently support these components.

    • Schema Object: oneOf, anyOf, additionalProperties properties
    • Discriminator Object
    • Info object: termsOfService, contact, license fields
    • Example Object
    • Link Object
    • Callback Object
    • Security Scheme Object
    • Security Requirements Object
    • Tag Object
    • External Documentation Object
    • Server Object
    • Specification extensions
    • Recursive references

    More information on these components is available in the OpenAPI documentation. See OpenAPI Specification.

    Maximum number of operations supported
    The number of API operations is limited to 500 by default. However, using the system property glide.rest.openapi.max_operation_limit, you can configure the number of operations from 1 through 1000.

    App version

    Spoke Generator v2.0.1 is the latest version.