Here you will find the documentation you need to build custom connectors to applications Workato currently doesn't support using our SDK. Creating your own connector is normally only necessary when our platform has not yet built a connector for the application you are looking for or we dont support the triggers or actions you need. Building a custom connector is made much easier with basic understanding of coding and allows you to connect to any application that has an API exposed. Workato also has custom actions and our own HTTP connectors that might be more suitable if your integration needs aren't so complex. Learn more about whether to use the SDK, custom actions or our HTTP connection for your integration needs.
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 which we call a 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.
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 dataformat.
First up, lets go through a brief overview of our SDK before getting our feet wet together with a guided walkthrough for our first connector!
- SDK Conceptual Model
- Walkthrough - Building your first connector!
- Data Format
- HTTP requests
- Object definitions
- Advanced object definitions - Pick lists
- Advanced object definitions - Toggle fields
- Advanced object definitions - Config fields
- Error handling
- Best Practices
- How-to guides
- Sharing the connector