27 Jun
Introduction
This tutorial will guide you through the process of importing the CloudTools OpenAPI specification into ServiceNow Integration Hub. We will use the OpenAPI specification file available at Apptigent CloudTools for Salesforce Sales Cloud.
Prerequisites
- Access to ServiceNow with Integration Hub enabled.
- OpenAPI specification file for CloudTools.
Steps to Import OpenAPI Specification
1. Log in to ServiceNow
- Navigate to the ServiceNow login page.
- Enter your credentials to access the dashboard.
2. Navigate to IntegrationHub
- In the Application Navigator, type IntegrationHub and select IntegrationHub from the list of modules.
3. Create a New Connection & Credential Alias
- Click on Connections & Credentials under the IntegrationHub module.
- Click New to create a new Connection & Credential Alias.
- Provide a name for the alias (e.g., “CloudTools Connection”).
- Set the Connection Type to REST.
- Enter the necessary authentication details (e.g., API Key, OAuth).
- NOTE: If using OAuth, be sure to import the OAuth version of the CloudTools for Salesforce OpenAPI specification.
4. Import OpenAPI Specification
- Go back to the IntegrationHub module and select REST under Designers.
- Click Create REST API Integration.
- Select Import OpenAPI and upload the JSON file you downloaded from the provided URL.
- The system will parse the OpenAPI specification and create corresponding actions.
5. Review and Save Actions
- Review the generated actions to ensure they are correctly interpreted.
- Click Save to store the actions in your instance.
6. Configure Actions in a Flow
- Navigate to Flow Designer from the Application Navigator.
- Create a new flow or open an existing flow where you want to use the CloudTools actions.
- Add a new action by clicking on the + icon.
- Select the actions created from the OpenAPI import.
- Configure the action by mapping the necessary input and output parameters.
7. Test and Deploy
- After configuring the actions in your flow, test the flow to ensure everything is functioning as expected.
- Once validated, activate the flow for production use.
Conclusion
By following these steps, you have successfully imported the CloudTools OpenAPI specification into ServiceNow Integration Hub and configured it within a flow. This integration allows for seamless automation of processes using CloudTools capabilities.
For more detailed information, refer to the official ServiceNow Integration Hub documentation and Outbound REST documentation.
