Start a workflow asynchronously

post/workflow/start

Request body

workflowNamestring required

The name of the workflow to execute

{"stackTrail":"paths:/workflow/start:post:requestBody:content:application/json:schema:properties:input","oasType":"schema","type":"unknown","description":"The payload to send to the workflow"}
workflowIdstring

(Optional) The workflowId to use. Must be unique

catalogstring

The catalog (Temporal task queue) to route the execution to. Falls back to the default catalog.

taskQueuestring

Deprecated alias for catalog. If both are sent, catalog wins.

Response

The workflow start result

workflowIdstring

The id of the started workflow

runIdstring nullable

The first execution's run id for this workflow

Changes

Changed in 5 of the 20 revisions of this API.3512

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the new optional request property

      new-optional-request-property

    • request property deprecated

      request-property-deprecated

  • 01552bfa957923See the full diff
    • added to the response body oneOf list for the response status

      response-body-one-of-added

    • the response's body type changed from object to no type for status

      response-body-type-changed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the optional property to the response with the status

      response-optional-property-added

  • 0f0e49049ef1127See the full diff
    • the response's body type changed from no type to object for status

      response-body-type-changed

    • removed the request property

      request-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • request property reactivated

      request-property-reactivated

    • removed from the response body oneOf list for the response status

      response-body-one-of-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog