Connector Builder

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

Fundamentally, a connector is a collection of API endpoints and data manipulation functions sequenced as flows. Connector Builder packages these flows with authentication and branding. Customers can use these connectors in their own tenants, or submit them to the Okta Integration Network for inclusion in the public catalog for use by anyone using the Okta Workflows platform.

Get started quickly with the basics

Perform the basics to create a connector.

1. Create a connector
2. Connector settings
3. Authentication

4. Build basic authentication

5. Build OAuth 2.0 authentication

6. Build custom authentication

7. Flow types in Connector Builder

   • Build an httpHelper flow

   • Build an _authping flow

   • Build a custom API action card

   • Build a revoke flow

   • Build a webhook event flow

   • Register a webhook event

   • Deregister a webhook event

8. Deploy your connector

If you're new to Okta Workflows, consider working through Workflows Foundations for Flowgrammers, a free, self-guided course from Okta.

Learn about Connector Builder

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

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

Build connections

Manage the branding basics of a new connector.

• Create a connector

• Rename or delete a project

• 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 OAuth 2.0 authentication
• Build custom authentication
• Add parameters for connector authentication
• Test connections

Build action cards for your connector

Build the basic features of a card using the 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
• Build a webhook event flow

  • Register a webhook event

  • Deregister a webhook event

  • Enable run mode for webhooks

Add functions to flows

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

• Functions

Test and deploy your connector

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

• Test your flows
• Check execution history
• Deploy your connector
• Deployment validation errors

Best practices

Follow best practices for creating connectors.

• Best practices: Action card names and descriptions
• Best practices: Choose between an API Connector and Connector Builder
• Best practices: Options fields
• Best practices: Object shapes
• Best practices: Error handling
• Best practices: Rate limits
• Paginate

  • Paginate: set a maximum page index

  • Paginate: API endpoint

More resources for Connector Builder

Learn about feature limits and guidelines for submitting connectors.

• Connector Builder feature limits
• Connector Builder submission documentation
• Connector Builder submission testing