<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
Workflows - When to Use Connector Builder and when to Use the API Connector
Okta Classic Engine
Okta Identity Engine
Workflows
Overview
Workflows offers two options for integrating with applications that are not currently part of the connector catalog: the API Connector and Connector Builder. This article attempts to clarify the best use cases for each option.
Applies To
  • Okta Workflows
  • Connector Builder
  • API Functions
Solution

API Connector cards offer a lightweight solution for customers to make API calls to most services.  The credentials are stored securely, and an authorization header is created automatically using one of the provided types (Basic, OAuth 2.0 Authorization Code, or Custom). 

The API Connector is best used for non-repetitive API calls, as it requires manually parsing the response body with each use.  Repetitive uses of the same request are best encapsulated in helper flows to avoid this repetitive parsing.  Note that helper flows count against the flow limits defined for the organization’s plan.  See Flow limits for more information.  

Note: Today, flows containing the API Connector can be exported/imported between environments.  Flows that contain a connector built using Connector Builder can only be used on the tenant where the connector was created.  

Documentation: Authenticate with API Connector cards  


Connector Builder is a no-code development tool for creating productized connectors on the Workflows platform. These connectors can be built, tested, deployed to the tenant, and used just like any other integration in the connector catalog.  

Connector Builder is best used when a more productized end-user experience is desired.  It allows parsing an API response into drag-and-dropable outputs for use across multiple flows.  This can be helpful when not all members of a team have the same familiarity working with APIs.  It is also helpful when dealing with non-standard authentication mechanisms where additional parameters are required or to connect with services that use the Client Credentials OAuth grant type. 
 
Important: Connectors built using Connector Builder cannot be moved between Okta orgs just yet (for example, from Preview to Prod), so make sure to pick the right home for the connector before beginning.  

Additionally, connectors created with Connector Builder can be submitted to the OIN for review and publication in the connector catalog.  See Connector Builder submissions for more information.  For other connectors built with Connector Builder, please see the list of partner-built connectors at the bottom of the Connectors page.  

Documentation: Workflows Connector Builder

 

Related References

Loading
Workflows - When to Use Connector Builder and when to Use the API Connector