Workflows Connector Builder

This is an Early Access feature for existing Workflows users. To enable it, use the Early Access Feature Manager as described in Manage Early Access and Beta features.

Connector Builder is a no-code development tool for creating connectors on the Workflows platform. It leverages the same Workflows functionality used by Okta customers to turn their use cases into automated flows.

At its most basic, a connector is a collection of API endpoints and data manipulation functions sequenced as flows. Connector Builder packages these flows with authentication and branding to be used by customers in their own tenants, or submitted to the Okta Integration Network for inclusion in the public catalog for use by all Okta customers on the Workflows platform.

New to Workflows? See the free, self-guided course in the Okta Learning Portal: Workflows Foundations for Flowgrammers.

Get started quickly with the basics

Perform the basics to create a new connector.

1. Create a new connector
2. Connector settings
3. Authentication
   • Build basic authentication
   • Build authentication with OAuth 2.0
   • Build custom authentication
4. About flow types
   • Build an httpHelper flow
   • Build an _authping flow
   • Build a Custom API Action card
   • Build a _revoke flow
5. Deploy your connector

Learn about Connector Builder

Read introductory concepts on authentication and the components of event and action cards in Workflows.

• Building blocks of a connector
• Connections
• Connector settings
• Preview in Connector Builder
• Authentication
• Flow types in Connector Builder
• Dynamic dropdown, fields, and groups
• Extensible input fields
• Functions
• Custom API Action (CAPIA) cards

Build connections

Manage the branding basics of a new connector.

• Create a new connector

• Rename or delete a connector

• Create and edit connector settings

Build authentication for your connector

Authentication is where you define the parameters that are needed to create a connection to your service. Build basic, OAuth 2.0, or custom authentication for your service.

• Build basic authentication
• Build authentication with OAuth 2.0
• Build custom authentication
• Add parameters for a connector's authentication
• Test connections

Build action cards for your connector

Build the basic features of a card using Connector Builder Options, Inputs, and Outputs dialogs.

• Add option fields to connector cards
• Add static values for a dropdown options field
• Add a dynamic dropdown field: HTTP example
• Add dependent options to an action card
• Add input and output fields to connector cards
• Add static values for a dropdown input field
• Add dynamic input fields: HTTP example
• Add selectable outputs to an action card

Build common flows

Build the common flows that most connectors should have.

• Build an httpHelper flow
• Build an _authping flow
• Build a Custom API Action card
• Build a _revoke flow

Add functions to flows

Learn about all the function cards that are available in Connector Builder.

• Functions in Workflows

Test and deploy your connector

Test and deploy a new connector, and learn about Connector Builder validation errors.

• Test your flows
• Check Flow History
• Deploy your connector
• Connector Builder deployment validation errors

Best Practices

Follow best practices for creating connectors.

• Best practices: Action card names and descriptions
• Best practices: Options fields
• Best practices: Object shapes
• Best practices: Error handling
• Best practices: Rate limits
• Paginate
  • Paginate: Set a Max Page Index
  • Paginate: API Endpoint

Additional resources for Connector Builder

Learn about feature limits and guidelines for writing user documentation for your connector and action cards.

• Connector Builder feature limits
• Prepare connector documentation

• Base URL: This is the first portion of an API’s url that is common among all endpoints (i.e. https://api.box.com/2.0/). If the URL includes a subdomain or other account specific details, they can be denoted using double mustache brackets (i.e. https://{{instance}}.service-now.com/api/)
• Header Name: A custom name to be passed to the service. For example, a service may require “api_key” as the header name and the key itself as the value.
• Header Value: The value to be passed to the service along with the Header Name

• Check the Save all data checkbox in the Save dialog. This can be accessed when first saving the Flow or by reopening the dialog by clicking on the flow name.
• Click on the Enable Save Data link in the right pane of the Flow History page.