ballerina/workflow.activity Ballerina library

Calls a REST API as a workflow activity.

The connection argument must be a module-level final http:Client variable in the user's program. The compiler plugin generates the wiring that makes it available on the activity worker side.

Example:

final http:Client api = check new ("https://api.example.com");

type User record {| int id; string name; |};

@workflow:Workflow
isolated function myWorkflow(workflow:Context ctx) returns error? {
    User user = check ctx->callActivity(activity:callRestAPI, {
        connection: api,
        method: "GET",
        path: "/users/1"
    });
}

Calls a SOAP endpoint as a workflow activity.

The connection argument must be a module-level final soap11:Client or soap12:Client variable in the user's program. Both SOAP 1.1 and 1.2 clients are supported. The action parameter is required for SOAP 1.1 and optional for SOAP 1.2.

Example:

final soap11:Client calc = check new ("https://calc.example.com/svc?WSDL");

@workflow:Workflow
isolated function addNumbers(workflow:Context ctx) returns error? {
    xml envelope = xml `<soap:Envelope ...><soap:Body>...</soap:Body></soap:Envelope>`;
    xml response = check ctx->callActivity(activity:callSoapAPI, {
        connection: calc,
        body: envelope,
        action: "http://tempuri.org/Add"
    });
}

Sends an email as a workflow activity.

The connection argument must be a module-level final email:SmtpClient variable in the user's program. The activity sends the email using the email:SmtpClient.send() method.

Example:

final email:SmtpClient smtp = check new ("smtp.example.com", "user", "pass");

@workflow:Workflow
isolated function notifyWorkflow(workflow:Context ctx, string recipient) returns error? {
    check ctx->callActivity(activity:sendEmail, {
        connection: smtp,
        to: recipient,
        subject: "Order shipped",
        'from: "no-reply@example.com",
        body: "Your order is on the way."
    });
}