bytechef-embedded-automation-sample-code-workflow-java

A sample ByteChef embedded catalog code project written in Java. It is a plain jar: a class implementing com.bytechef.automation.project.ProjectHandler, registered through META-INF/services by @AutoService, that describes the project and its workflows with ProjectDsl and WorkflowDsl. The server finds the handler with ServiceLoader and runs each task's perform itself.

A catalog project is an ordinary automation code project - the same format the automation ProjectHandler path parses - imported under Embedded → Automations (the Automation Workflows page) instead of Automation → Projects. Importing publishes it to the embedded catalog straight away. A catalog workflow is called through the embedded public endpoints by its request or app-event (appEvent/newEvent) trigger, or runs on its own when a component trigger such as Gmail New Email starts it. A workflow with no trigger that can start it - none, or only a manual one - still imports, but the import returns a warning for it (the UI keeps the dialog open and shows the warning).

The project, "Sample Catalog Code Project Java", has four workflows, one class each under org.sample.codeworkflow.workflow:

• greetOnRequest (GreetOnRequestWorkflow), started by a request/v1/autoRespondWithHTTP200 trigger. It runs one task, greet, that logs and returns a greeting, and exposes that as the greeting output.
• summarizeNewEmail (SummarizeNewEmailWorkflow), started by the Gmail New Email polling trigger (googleMail/v1/newEmailPolling). It runs once for every new email in the connected user's inbox and returns a one-line summary as the summary output. It has no request trigger, so it needs no call - once provisioned and enabled it runs whenever an email arrives.
• fetchRecentEmails (FetchRecentEmailsWorkflow), started by a request/v1/awaitWorkflowAndRespond trigger. Its fetchEmails task calls the Gmail Search Email action and returns the matching messages as the emails output. The optional request body {"from": "...", "maxResults": 5} narrows the search.
• notifySlackOnNewEmail (NotifySlackOnNewEmailWorkflow), started by the Gmail New Email trigger, with a required channel input; its options come from Slack's own channel input (componentName, componentVersion and groupName on the input), so it is picked from the Slack workspace's channels. Its postToSlack task calls the Slack Send Channel Message action, so it declares a slack connection and passes its name. Provisioning binds it to one of the connected user's Slack connections; a user with none gets the reference created disabled and a 409 naming slack.

Connections

A task names the connections it uses and calls a component action through one of them:

task("fetchEmails")
    .connections(connection("googleMail", "gmail"))
    .perform(context -> context.component("googleMail", "searchEmail", Map.of("maxResults", 10), "gmail"));

When a connected user provisions a reference to a workflow, ByteChef binds every declared connection, and every component trigger, to one of that user's connections on the same component - for example the one they created when they connected a Gmail integration. Pass {"connections": {"googleMail": <connectionId>}} in the provision body to pick one. A user with no Gmail connection gets the reference created disabled and a 409 naming the missing component (missingConnectionComponentName).

Build

Requires JDK 25 (Gradle's toolchain selects it).

./gradlew build

The jar to deploy is build/libs/sample-catalog-code-project-java-1.0.0.jar.

libs/ holds the ByteChef SDK jars the code compiles against: project-api-1.0.jar and workflow-api-1.0.jar. They are compileOnly - the server provides them at runtime, so they must not be packed into your jar. To refresh them, run ./gradlew :sdks:backend:java:workflow-api:jar :sdks:backend:java:automation:project-api:jar in the ByteChef repository and copy the jars from each module's build/libs/.

Deploy

Uploading a jar requires bytechef.workflow.code-workflow.java-enabled: true on the server (the default). When it is off, the import dialog only offers .js and .py files and the API rejects jars.

Deploying a project with the same name again publishes a new version of that catalog project instead of creating a second one.

From the UI

Embedded → Automations → the arrow next to New Project → Import Code Project, then pick the jar.

Through the public API

POST /api/embedded/v1/automation-project-code-workflows/deploy with a multipart/form-data body holding one file part, projectFile: the jar. The file name must end in .jar; the server picks the language from the extension. A successful deploy returns 200 with the import warnings, for example {"warnings": []}. GET /api/embedded/v1/automation-project-code-workflows lists the published catalog projects.

Authenticate with Authorization: Bearer <API key>, using an Embedded API key (Embedded → Settings → API Keys) that belongs to an administrator - deploying requires the admin role. This endpoint takes only a typed API key: an organization admin key (Settings → Organization → Admin API Keys) is rejected with 401. The key is looked up in the environment named by the X-ENVIRONMENT header (DEVELOPMENT, STAGING or PRODUCTION; PRODUCTION when the header is absent), so send the environment the key was created in. The request runs as the key's own ByteChef user, not as a connected user.

curl -X POST "$BYTECHEF_URL/api/embedded/v1/automation-project-code-workflows/deploy" \
  -H "Authorization: Bearer $BYTECHEF_EMBEDDED_API_KEY" \
  -H "X-ENVIRONMENT: DEVELOPMENT" \
  -F "projectFile=@build/libs/sample-catalog-code-project-java-1.0.0.jar"

BYTECHEF_URL is the server's base URL, for example http://localhost:9555 for a local development server.