Get trigger requirements for workflow | Docusign

{
  "trigger_id": "c30c7afc-7d56-451c-b889-0a6488822fca",
  "trigger_event_type": "HTTP",
  "trigger_http_config": {
    "method": "POST",
    "url": "https://api-d.docusign.com/v1/accounts/7f09961a-a22e-4ea2-8395-d7648b81f20c/workflows/a4490cd8-d30d-454a-be13-f68578bb4235/actions/trigger"
  },
  "trigger_input_schema": [
    {
      "field_name": "Name",
      "field_data_type": "String"
    },
    {
      "field_name": "Email",
      "field_data_type": "String"
    },
    {
      "field_name": "Company",
      "field_data_type": "String"
    }
  ],
  "metadata": {
    "created_at": "2025-01-26T18:17:06.208+00:00",
    "created_by": "3d2ac2f5-4adb-4537-8f69-d9feb328052b",
    "modified_at": "2025-01-26T18:21:11.131+00:00",
    "response_duration_ms": 804,
    "response_timestamp": "2025-05-13T21:01:05.4823174Z"
  }
}

This operation retrieves the configuration and input requirements necessary to trigger a specific Workflow Builder workflow. It provides detailed information about the trigger_event_type, such as HTTP or other supported types, and specifies the required input schema, including field names, data types, and any default values.

This information is essential for understanding the data and parameters required to initiate the workflow. It enables developers to prepare the necessary inputs and configuration before triggering the workflow instance, ensuring seamless execution and compliance with workflow requirements.

Use Cases:

Identifying the required input fields and their data types to successfully trigger the workflow.
Reviewing the trigger configuration for validation and compliance with expected input.
Preparing and validating data in advance of triggering the workflow, minimizing runtime errors.

Key Features:

Detailed Trigger Input Requirements: Provides an exhaustive schema of required fields, their data types, and optional default values for easy reference and data validation.
Trigger Event Type Information: Specifies the type of event required to initiate the workflow (e.g., HTTP), helping developers configure their systems to invoke the workflow appropriately.
Configurable for Custom Triggers: Suitable for custom configurations, enabling flexibility in how workflows can be triggered according to system needs.

Authentication

AuthorizationBearer

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

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

The unique identifier of the account.

workflowIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

A universally unique identifier (UUID) in standard 8-4-4-4-12 format.

Response

Describes the requirements for triggering a workflow

trigger_idstringOptionalformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

A universally unique identifier (UUID) in standard 8-4-4-4-12 format.

trigger_event_typeenumOptional

The type of event that triggers the workflow. In this case, the workflow is initiated by an HTTP request. Future iterations may support additional event types beyond HTTP.

Allowed values:

trigger_http_configobjectOptional

Configuration details specific to HTTP-triggered workflows. This object describes the HTTP method and URL that will trigger the workflow, providing the endpoint and method that should be used to initiate the workflow.

trigger_input_schemalist of objectsOptional

A list of input fields that define the structure of the data required to trigger the workflow. Each item describes a field that must be included in the request when the workflow is triggered. The schema includes the field name, expected data type, and any default values for the input.

metadataobjectOptional

Metadata related to the workflow definition, including details about when the workflow was created, who created it, when it was last modified, and by whom. This information is useful for tracking changes to the workflow over time and identifying the user or system responsible for creating or modifying the workflow.

response_timestampdatetimeOptional

The timestamp indicating when the response was generated.

response_duration_msintegerOptional>=0

The duration of time, in milliseconds, that the server took to process and respond to the request. This is measured from the time the server received the request until the time the response was sent.

request_idstringOptionalformat: "uuid"

Unique identifier for the request, useful for tracking and debugging.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error