Actions and workflows

Use resource actions to execute operations configured on a resource. Use a workflow UID to run a configured workflow. Input keys come from your action or workflow configuration.

Execute an action

import { Jet } from '@jet-admin/jet-sdk';

async function runAction(jet: Jet, data: Record<string, unknown>) {
  const response = await jet.action('YOUR_RESOURCE', 'YOUR_ACTION').execute({ data });
  return response.data;
}

execute({ data }) sends POST to {resource}/actions/{action} and returns CollectionRecord. Read the result through .data. Pass { data: {} } if the configured action takes no inputs.

Run a workflow

import { Jet } from '@jet-admin/jet-sdk';

async function runWorkflow(jet: Jet, data: Record<string, unknown>) {
  const response = await jet.workflow('YOUR_WORKFLOW_UID').execute({ data });
  if (!response.success) {
    console.error('Workflow failed', response.error);
    return;
  }
  return response.result;
}

execute({ data }) sends POST to workflows/{uid}/run. It resolves to WorkflowResponse with success: boolean, result?: unknown, and error?: unknown.

Check success even when the HTTP request resolves. HTTP failures reject separately, as described in Errors and troubleshooting. The SDK offers no workflow status polling, cancellation, or retry method.