Skip to main content

Creating a Simple Activity

A Simple Activity is the foundational building block of the Koodisi platform. It is a self-contained, directly executable step that can be placed inside any workflow. Simple activities encapsulate a specific action — calling an API, transforming data, writing to a file, evaluating a condition — and expose a configuration form to the workflow builder.

Simple activities are also the members that make up a Cluster Activity.

info

Location: Library > My Artifacts > Activities — click Create Activity, then select Simple Activity as the type.

The Creation Wizard​

Creating a Simple Activity follows a 4-step wizard:

StepNamePurpose
1Add DetailsName, type, group, description, tags, icon
2ConfigurationDesign the form users see in the workflow builder
3TestingRun a test execution with sample inputs
4PublishReview and publish the activity organisation-wide

Step 1 — Add Details​

This step defines the identity and metadata of the activity.

Fields​

FieldRequiredValidationDescription
IconOptionalSVG onlyVisual identifier shown in the activity palette. Click the icon area to open the picker or upload a custom SVG.
Activity NameRequiredNo spaces or special characters; max 35 characters; unique within the selected groupThe identifier used across the platform to reference this activity.
Activity TypeRequired—Select Simple Activity.
Activity GroupRequired—The category this activity is listed under in the palette. Select an existing group or click + Create Group to make a new one.
DescriptionOptionalMarkdown supportedExplain what this activity does, its expected inputs, and when to use it.
TagsOptional—Comma-separated labels for filtering and discovery.
AccessOptionalDefault: onWhen enabled, the activity is visible and usable by all members of your organisation.

Activity Name Rules​

  • Letters, numbers, hyphens, and underscores only — no spaces or special characters.
  • Maximum 35 characters.
  • Must be unique within the selected Activity Group.

Duplicate name handling: If a name already exists in the group, a notification appears with two options:

  • Overwrite as draft — Creates a new draft version of the existing activity. The live version remains active until the new draft is published.
  • Rename — Focuses the name field so you can choose a different name.

Activity Groups​

Groups organise activities in the palette. To create a new group:

  1. Click + Create Group next to the Activity Group dropdown.
  2. Enter a name and click Save.
  3. The new group is selected automatically.
note

Changing an activity's group after it has been assigned resets any cluster data associated with it.

Step 2 — Configuration​

The Configuration step opens the Activity Form Builder — the visual drag-and-drop editor where you design the panel users see when they place this activity in a workflow.

Key things to do here:

  • Drag field types from the left toolbar onto the canvas to add inputs.
  • Click any field to configure its properties (label, key, required, placeholder, conditions).
  • Use Mappable Fields for values that should be bindable to workflow variables or resources.
  • Use Remote Select for dropdowns populated from a live API.
  • Organise fields into sections using the group tabs (Configuration, Input Mapping, Output Mapping).

See Activity Form Builder for full documentation on building the configuration form.

Step 3 — Testing​

The Testing step lets you run the activity against a live execution environment before publishing it.

  1. Fill in the Test Description — a note about what this test verifies.
  2. Provide test input values for each field in the Configuration form.
  3. Click Run Test.
  4. Review the output and logs.

The activity must pass testing before you can proceed to Publish. This gate ensures no broken activities reach your organisation's workflow builders.

note

The Testing step is skipped automatically for Cluster Activities and Subflow activities, since those types are not independently executable.

Step 4 — Publish​

The Publish step shows a read-only summary of everything configured in the previous steps:

  • Metadata (name, type, group, description, tags)
  • Form layout preview
  • Cluster members (if applicable)

Review the details and click Publish to make the activity available organisation-wide. Once published, the activity appears in the activity palette for all workflow builders in your organisation.

Editing a Simple Activity​

  1. Navigate to Library > My Artifacts > Activities.
  2. Locate the activity and click the Edit icon.
  3. The wizard reopens. The activity name is locked in edit mode — creating a new draft version with the same name automatically.
  4. Make your changes across the steps and click Publish to release the updated version.
note

Editing an activity with an existing live version creates a draft. The live version continues to run in deployed workflows until the draft is published.