(opens new window)

Introduction

Here you will find the SDK documentation you need to build custom connectors to applications Workato currently doesn't support just yet. Building a great connector on Workato means managing both technical aspects as well as the user experience that you provide to those using your connector.

Workato was built with the philosophy that anyone can do enterprise-level integrations without any coding involved. As such, connectors on the platform should aim to balance functionality with ease of use. Whether you're developing a connector for your own team's use or you're a 3rd party developer looking to list your connector on Workato, reading this documentation is useful in getting you started on your journey.

What is a custom connector?

A connector allows Workato to interact with a single application through a series of triggers and actions. Triggers monitor for events that occur in the application you hope to connect to and kickstart a workflow of actions that we call recipes. Actions carry out specific pre-defined operations in the target application.

Connectors built on the SDK are called custom connectors. These connectors have a private scope by default which means that they are only visible and available to the connector owner. After the connector is built and ready, you also have the ability to share it with others on various levels.

Before we begin...

Workato has a whole host of other features and functionalities that might help you achieve what you are hoping for such as our universal HTTP connector or custom actions if your integration needs aren't so complex. Learn more.

If you've decided that a custom connector is necessary, do check in at our developer portal (opens new window) to see if anyone has contributed a custom connector to the application you're looking for. Our friendly support team via chat on our main website can also help you check our internal repository of custom connectors built by our customer success team.

Reading the SDK documentation is still useful as you'll be able to install these custom connectors and continue working on them if you wish to do so.

Documentation Format

This section will list everything you need to know about our SDK as well as provide some guides, walkthroughs and example connectors that our users have built. You may use the links below to skip ahead to your desired section but it is recommended that you go through this documentation the order stated so as to not miss any of the features we have that might help you down the line.

In our documentation, we default to JSON when giving examples. It is highly recommended that you read about how other data formats can be handled if the API you plan to connect to uses a different data format.

• Quick Start guide to using the Workato SDK platform
• SDK Overview
• Walkthrough - Building your first connector!
• Data Format
  • JSON
  • XML
  • Multipart form
  • URL encoded form
• Authentication
  • Basic Authentication
  • Header Authentication
  • OAuth 2.0
  • Custom Authentication
  • Testing your connection
  • Defining a base URI
  • On premises connections
• Actions
• Triggers
  • Polling triggers
  • Static Webhook triggers
  • Dynamic Webhook triggers
• HTTP requests
• Object definitions
• Object definitions - Pick lists
• Object definitions - Toggle fields
• Object definitions - Config fields
• Methods
• Error handling
• Best Practices
  • General best practices
  • Block specific best practices
    • Connection block
    • Test block
    • Object definitions block
    • Actions block
    • Triggers block
    • Sample output block
    • Error handling
  • Usability and testing best practices
• Examples

Coming soon

• How-to guides
• Troubleshooting
• Sharing the connector