Zenity Workato Integration via API token

This guide explains how to create and configure an integration between Zenity and Workato using a new API token.

After reading this document, you'll be able to:

  1. Create a new Client role in Workato.
  2. Create an API client with specific permissions in Workato.
  3. Use the API client token created to connect your Workato account to Zenity.

For additional assistance with your configuration and set up, please sign into your Zenity account and open a support ticket

Create Client Role

Note: Admin privileges are required to create the API role and client.

To create the client role:

  1. Sign in to your Workato account.

  2. From the left menu, select Workspace access. image

  3. Select Client roles from the API clients tab. image

  4. Create the new role by clicking on Add client role. Make sure to create the role with the following permissions selected

Projects tab

Projects & Folders
  • List | GET /api/folders
  • List projects | GET /api/projects
Connections
  • List | GET /api/connections
 Recipes
  • LiST | GET /api/recipes
  • Get details | GET /api/recipes/:id
Recipes (For Zenity actions and playbooks)
  • LiST | GET /api/recipes
  • Get details | GET /api/recipes/:id

image

Tools tab

Environment Properties
  • List | GET /api/folders
  • List | GET /api/properties
Connector SDKs
  • List | GET /api/custom_connectors
Collections & endpoints If API platform addon is enabled:
  • List collections | GET /api/api_collections
  • List endpoints in a collection | GET /api/api_endpoints
Clients & Access Profiles If API platform addon is enabled:
  • List clients | GET /api/api_clients

image image

Admin tab

Collaborator roles
  • List non-system roles | GET api/roles
Workspace details
  • Get details | GET /api/users/me

image

Make sure to verify all of your settings and click “save changes” to confirm creation of the specified role. After creating the role, the next step is to create the API Client.

Create Client Role

  1. Sign in to Workato, or access the main menu if you are already signed in.
  2. From the left menu, Select Workspace access.

image

  1. From the API clients section, select the API clients tab.

image

  1. Select Create API client to create the new API.
  2. Assign the role you created during the Create Client Role procedure to the API.
  3. Assign the specific projects that should be included in integration or choose all projects to include all of the projects in your Workato account to the integration.
  4. In case you need to restrict this client to Zenity’s IPs only, add 18.200.62.37 and 52.31.196.233, 108.128.206.229 , 99.81.56.225 used by Zenity services to the Allowed IPs section.

  5. When finished, click Create client. image

  6. Copy the newly generated API token and save it in a secure location. image

Congratulations. You’ve successfully created the new role required, and created the API client. Now, let’s integrate with Zenity.

Create Zenity Integration

Note: Zenity Admin permissions are required to create the integration.

  1. Sign in into your Zenity account.
  2. From the left menu, select Integrations, then select Create new, and complete the following steps.
  3. Enter a unique name for the integration.
  4. Select the environment the new integration will be connected to Production, Development or Test.
  5. Select Workato as the platform.
  6. Select API token as the authentication method.
  7. Paste the new API token you created and saved during the Create API Client procedure into the API token field.
  8. Click Create image

Congratulations. You’ve successfully completed the Workato API integration with Zenity! For additional support or help with Zenity integrations, open a support ticket