Skip to main content

Creating an Application

An application is the container for a single integration. It holds the workflows that run your logic, the resources that connect to external systems, and the schemas that define the data moving between them. Create one application per integration you are building, so its parts can be deployed, exported, and versioned together.

Before you begin​

  • You need the permission to create applications in the workspace. Without it, Create Application is unavailable.
  • Each workspace allows up to 10 active applications. If you have reached the limit, deactivate an application you are no longer using before creating another.

Choose how to start​

Choose Application Type offers three ways to create an application.

OptionUse it when
New ApplicationYou are starting from scratch, or from a pre-built template.
OpenAPIYou have an API specification and want the endpoints configured for you.
Clone from gitThe application already exists in a Git repository.

Where you start determines whether you see this screen. Selecting Create Application on the Applications card of the Home page goes straight to the New Application form. Selecting + at the top of the Applications panel shows Choose Application Type first.

Create a blank application​

  1. Select + at the top of the Applications panel, then select New Application.
  2. Enter a name in the Name field.
  3. Leave Use template set to Default, or select a pre-built workflow to start from.
  4. Select the Application Type.
  5. Select Create.

Field reference​

FieldRequiredDescription
NameYesIdentifies the application. Maximum 50 characters. Letters, numbers, underscores, and single spaces.
Use templateNoStarts the application with a pre-built workflow instead of an empty one. Default creates a blank application.
Application TypeYesDetermines the runtime engine. Workflow and CDC are not currently selectable.

Application types​

TypeWhat it is for
OrchestrationThe standard choice for workflow-based integrations.
BundlePackages custom activities so they appear in the activity library for use in other applications. Bundle applications cannot be used with Git.

Create an application from OpenAPI​

Select OpenAPI in Choose Application Type, then supply the specification. Studio configures the endpoints, headers, and schemas from the spec rather than requiring you to enter them.

For how specifications are stored and reused, see Working with OpenAPI Specs.

Clone an application from Git​

  1. Select + at the top of the Applications panel, then select Clone from git.
  2. Enter a Name for the local application.
  3. Select the Application Type.
  4. Enter the Remote Url of the repository.
  5. Select Multi module repository if the repository holds more than one application.
  6. Choose how to authenticate:
    • Use Existing Credentials — select a saved Credential Name.
    • New Credentials — select the Git Provider, enter a Credential Name, and provide a Personal Access Token.
  7. Select Clone.

The modal is titled Clone an application. For repository conventions and branching, see Using Git to Develop Applications.

How you know it worked​

A confirmation message reads <name> application created successfully., and Studio opens the new application. It appears in the Applications panel containing empty folders for its workflows, resources, and schemas.

When it does not work​

Create stays disabled until the Name field holds a valid, unused name. These messages appear beneath the field:

MessageCause
Name is requiredThe field is empty.
Name cannot be more than 50 charactersThe name exceeds the length limit.
Application name cannot start with a space.The name begins with a space.
Only one space between words allowed.The name contains consecutive spaces.
Special characters are not allowed.The name contains anything other than letters, numbers, underscores, and spaces.
Hyphens are not allowed in the application name.The name contains -.
At least one alphanumeric character required.The name is only spaces.
This is a reserved name. Please choose another name.The name is oe, ivoyant, or system.
App name already exists.Another application in the workspace uses this name.

Two errors can appear after you select Create:

MessageCauseWhat to do
Active application limit reached in your workspace <workspace>The workspace already has 10 active applications.Deactivate an application you are not using, then create this one.
Something went wrong while creating ApplicationsThe application could not be saved.Retry. If it persists, confirm you are still signed in and contact your workspace administrator.

Next steps​

Add a workflow to the application to define what the integration does.