Custom Connector Docs
Documentation and SDK for building custom application connectors for the Workato integration platform.
Overview
This repository contains the official documentation and SDK for developers to build custom adapters (connectors) for the Workato platform. It enables the creation of private or public connectors to integrate with any application's API, extending Workato's automation capabilities.
Key Features
- Custom Adapter Development — Build connectors using a Ruby-based SDK to define triggers, actions, and object definitions.
- Multiple Authentication Methods — Supports Basic Auth, API Key, OAuth 2.0, and custom authentication schemes.
- Trigger Types — Includes poll triggers (classic and descending) and webhook triggers for real-time event handling.
- Dynamic Object Definitions — Define input/output schemas statically or dynamically based on API responses.
- Pick Lists & Configuration Fields — Create dynamic dropdowns and context-dependent input fields for recipe builders.
- Example Connectors — Provides numerous sample adapters for popular services like Harvest, Freshdesk, and Podio.
Philosophy
The SDK is designed to abstract authentication and request handling, allowing developers to focus on defining business logic and data mappings for seamless integration within the Workato ecosystem.
Related Projects
Embedding GuideThis project provides a step-by-step guide for embedding Workato's web application within another vendor's platform. It demonstrates how to map URLs, handle navigation events, and integrate the Workato Embedding Client to create a seamless embedded experience. ## Key Features - **URL Mapping** — Establishes a correspondence between Workato URLs and internal vendor URLs for consistent routing. - **Iframe Integration** — Renders Workato content within an iframe, with the src attribute dynamically set based on URL mapping. - **Embedding Client Script** — Injects the Workato Embedding Client JavaScript to enable communication and control of the embedded app. - **Navigation Event Handling** — Subscribes to Workato's navigation events to synchronize page changes between the embedded app and the host application. - **Normal Link Navigation** — Uses standard anchor tags for navigation, ensuring a cohesive user experience across pages. ## Philosophy The guide emphasizes a straightforward, configuration-driven approach to embedding, focusing on clear URL mapping and event-driven communication to integrate Workato seamlessly into existing vendor platforms.
SystematicThe only community for business systems
The ConnectorWorkato blog on Business Automation
Solution MarketplaceA curated list of ready-to-use solutions built by Workato and vendors
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.