api.triggerJob()

​

api.triggerJob()

• Unavailable with readOnly: true (throws an error).
• Convenience wrapper for api.triggerTarget('JOB_TEMPLATE', templateIdOrName, ...).
• The input argument is copied directly into the target job’s flat api.input().templateInputs, shallow-spread over template defaults. Non-colliding defaults remain and matching keys are overwritten; it is not nested under templateInputs.input or exposed at top level.
• Pass { scheduleFor }; the maximum horizon is 30 days.
• Retired positional date and relative-delay arguments are ignored.

​

Signature

static triggerJob(
      templateIdOrName: string,
      templateInputs?: Record<string, JsonValue>,
      options?: AutomationScheduleOptions,
    ): Promise<string>;

​

Example

const jobId = await api.triggerJob(
  templateId,
  { customerId: 'c-1' },
  { scheduleFor: new Date(Date.now() + 15 * 60 * 1000) },
);