Are you an integration developer?
You've likely used one of our Integration Hub Spokes knowingly or unknowingly. Integration Hub Spokes are ready-to-use integration specific applications that ship with pre-built Actions, Flows, Subflows, Triggers, and AI Agents that you can use within ServiceNow's Workflow Studio or AI Agent Studio for your integration and automation needs. If you haven't used Spokes directly, there is a strong possibility you have used one of our integration solution's, that ship with various ServiceNow products, that make use of Integration Hub Spokes under the hood. To know more about what Integration Hub Spokes and integration solutions are – read this blog.
What if you have an integration need and don't find a spoke for that?
We have a solution for you - Spoke Generator - a no-code guided experience for building a new Integration Hub Spoke.
Here's a step-by-step Guide:
===== Installation =====
- Navigate to Plugins in your ServiceNow instance.
- Search for Spoke Generator.
- Install Spoke Generator.
===== Create Spoke =====
- Navigate to Workflow Studio -> Integrations -> Spokes
- You will see a list of all applications that have at least one Spoke Action. You can navigate to an existing application and generate new Spoke Actions for those as well. However, in this blog post we will be showcasing how to create a new custom Spoke. We will be using Docusign Maestro as an example.
- Click "New Spoke"
Spokes List
- Choose "Create a Spoke in new scope"
- Provide Spoke name. App scope name will auto populate.
- Provide Description.
- Provide Logo.
- Click Continue.
Your Spoke application shell is ready!
===== Import OpenAPI and create an alias =====
- Now its time to add Spoke Actions to the Spoke. You are provided choices.
- Using API Specifications
- Using OpenAPI specifications
- Using Postman collection
- Using documentation
- Action designer
- Now Assist
Options available for action generation
- Using API Specifications
- We will choose OpenAPI. Click "Continue".
- You can choose an existing OpenAPI specification or import new. Click "Import New".
- Choose "Import from JSON or YAML manually" as the import method.
- Paste the JSON or YAML in the area provided.
- Click "Import".
OpenAPI Specifications - JSON
- Your OpenAPI specifications are imported successfully.
- Next create a new connection & credential alias. Enter the name for the alias and Click "Create alias and continue". The configuration template for authentication is typically auto-populated, however you can double check with the third-party documentation for the most appropriate one.
Create alias
- Enter details for the alias. Click "Submit"
Configure alias
- Click "Generate operations"
Generate operations
===== Actions =====
- You will get a list of Spoke Actions generated from the operations available in the OpenAPI specifications.
- You can choose to create selected Actions or create all Actions
- You can choose to save these Actions as draft or publish them directly.
Choose actions to generate
- Once you have generated Actions, you can click "Done: Go to Spoke".
- You can open each of these Spoke Actions and view its details.
===== Output =====
A connection & credential alias you can configure
Spoke Actions to use in any Flow
There you have it! Your new spoke generated in minutes!
Now it's your turn to put it to the test with your own real-world scenarios. Start with a simple integration that's been on your backlog, then gradually tackle more complex use cases. Document your journey – what worked seamlessly, what surprised you, and where you see room for improvement. Share your success stories, creative solutions, and even your stumbling blocks in the comments below. After all, the best innovations come from real users solving real problems.
The clock starts now – let's see what you can build in minutes, not hours!
Happy integrating!
This article was published by @Shreya Shah and @Joe Wilmoth
2 Comments
