Trigger instance of workflow builder workflow
This operation triggers a new instance of a specified Workflow Builder workflow. When invoked, the workflow is started based on the provided input data, and the workflow instance begins executing according to its defined logic and configuration.
The request requires an instance_name and any input data necessary to start the workflow,
as described by the workflow’s trigger_input_schema. The instance_name is a user-defined
label for tracking the workflow run, while the input data fields should match the schema defined
in the workflow.
The operation is event-driven and typically triggered by an external HTTP event or system call, allowing for the automatic execution of complex processes that span multiple systems or components.
Upon successful execution, the response returns the unique identifier (id) for the newly
created workflow instance, along with a URL (workflow_instance_url) that can be used to
interact with or track the running instance.
Use Cases:
- Automating user registration workflows where input fields like
nameandemailare provided. - Processing financial transactions where details such as
amountandcurrencyare required. - Sending notifications based on user interactions in other systems.
Key Features:
- Automated Execution: Once triggered, the workflow runs until a step requires manual intervention.
- Input-Driven: Workflow execution is based on the provided input data, which is validated against the workflow’s input schema.
- Real-Time Triggering: Designed to be invoked as part of an event-driven architecture, allowing for workflows to respond to external events.
- Tracking and Interaction: The response includes a URL that allows users to check the status of the workflow instance or take further actions while it runs.
Authentication
OAuth2 authentication.
- Demo:
- authorizationUrl: https://account-d.docusign.com/oauth/auth
- tokenUrl: https://account-d.docusign.com/oauth/token
- Production:
- authorizationUrl: https://account.docusign.com/oauth/auth
- tokenUrl: https://account.docusign.com/oauth/token
Path parameters
A universally unique identifier (UUID) in standard 8-4-4-4-12 format.
Request
The input information needed to trigger a new instance of a Workflow Builder workflow. This request body contains the metadata to describe the instance being created, along with the input data required to trigger the workflow.
instance_nameprovides a user-defined name for the workflow instance.trigger_inputscontains the key-value pairs corresponding to the inputs required by the workflow, as described in thetrigger_input_schemafrom the workflow definition.
A descriptive name for the specific instance of the workflow being triggered. This is typically used for identification and tracking purposes. Example: “User Registration Workflow Instance”
A key-value pair where the key is the field_name defined in the trigger_input_schema of the workflow definition,
and the value is the actual input data. Supported types include string, number, boolean, object, or array.
Response
A unique identifier for this specific instance of the workflow. This UUID is used to reference the running instance in other API calls (e.g., to retrieve its status or terminate the instance). Example: ‘1a46ccde-9db4-42d6-94fa-0ddd07a3d2ff’
A fully-qualified URL that can be used to access or interact with this workflow instance while it is running. This URL may provide access to additional details, actions, or logs related to the workflow execution.