> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# Get trigger requirements for workflow

GET https://api-d.docusign.com/v1/accounts/{accountId}/workflows/{workflowId}/trigger-requirements

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.


Reference: https://developers.docusign.com/docs/workflow-builder-api/reference/workflowbuilder/workflows/getworkflowtriggerrequirements

## Authentication

- `Authorization` header (bearer token, required) — 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

## Servers

- `https://api-d.docusign.com` (Demo, default)
- `https://api.docusign.com` (Production)

## Request

### Path parameters

- `accountId` (string, required) — The unique identifier of the account.
- `workflowId` (string, required) — A universally unique identifier (UUID) in standard 8-4-4-4-12 format.

## Response

### 200

Describes the requirements for triggering a workflow

- `trigger_id` (string, optional) — A universally unique identifier (UUID) in standard 8-4-4-4-12 format.
- `trigger_event_type` (enum, optional) — 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: `HTTP`
- `trigger_http_config` (V1AccountsAccountIdWorkflowsWorkflowIdTriggerRequirementsGetResponsesContentApplicationJsonSchemaTriggerHttpConfig, optional) — 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_schema` (list of V1AccountsAccountIdWorkflowsWorkflowIdTriggerRequirementsGetResponsesContentApplicationJsonSchemaTriggerInputSchemaItems, optional) — 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.
- `metadata` (ResourceMetadata, optional) — 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_timestamp` (datetime, optional) — The timestamp indicating when the response was generated.
- `response_duration_ms` (integer, optional) — 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_id` (string, optional) — Unique identifier for the request, useful for tracking and debugging.

## Errors

### 400 Bad Request Error

Bad Request - The request could not be understood or was missing required parameters.

- `type` (string, required) — A URI reference that identifies the problem type. Use 'about:blank' when the problem has no additional semantics beyond the HTTP status code.
- `title` (string, required) — A short, human-readable summary of the problem type.
- `status` (integer, required) — The HTTP status code.
- `detail` (string, optional) — A human-readable explanation specific to this occurrence of the problem.
- `instance` (string, optional) — A URI reference that identifies the specific occurrence of the problem (typically the request path).
- `timestamp` (datetime, optional) — The timestamp when the error occurred.
- `request_id` (string, optional) — Correlation identifier for the request, useful for support investigations.
- `errors` (list of ValidationError, optional) — Optional list of individual validation or domain errors.

### 401 Unauthorized Error

Unauthorized - Authentication is required and has failed or not been provided.

- `type` (string, required) — A URI reference that identifies the problem type. Use 'about:blank' when the problem has no additional semantics beyond the HTTP status code.
- `title` (string, required) — A short, human-readable summary of the problem type.
- `status` (integer, required) — The HTTP status code.
- `detail` (string, optional) — A human-readable explanation specific to this occurrence of the problem.
- `instance` (string, optional) — A URI reference that identifies the specific occurrence of the problem (typically the request path).
- `timestamp` (datetime, optional) — The timestamp when the error occurred.
- `request_id` (string, optional) — Correlation identifier for the request, useful for support investigations.
- `errors` (list of ValidationError, optional) — Optional list of individual validation or domain errors.

### 403 Forbidden Error

Forbidden - The request was valid, but you do not have permission to perform the action.

- `type` (string, required) — A URI reference that identifies the problem type. Use 'about:blank' when the problem has no additional semantics beyond the HTTP status code.
- `title` (string, required) — A short, human-readable summary of the problem type.
- `status` (integer, required) — The HTTP status code.
- `detail` (string, optional) — A human-readable explanation specific to this occurrence of the problem.
- `instance` (string, optional) — A URI reference that identifies the specific occurrence of the problem (typically the request path).
- `timestamp` (datetime, optional) — The timestamp when the error occurred.
- `request_id` (string, optional) — Correlation identifier for the request, useful for support investigations.
- `errors` (list of ValidationError, optional) — Optional list of individual validation or domain errors.

### 404 Not Found Error

Not Found - The requested resource could not be found.

- `type` (string, required) — A URI reference that identifies the problem type. Use 'about:blank' when the problem has no additional semantics beyond the HTTP status code.
- `title` (string, required) — A short, human-readable summary of the problem type.
- `status` (integer, required) — The HTTP status code.
- `detail` (string, optional) — A human-readable explanation specific to this occurrence of the problem.
- `instance` (string, optional) — A URI reference that identifies the specific occurrence of the problem (typically the request path).
- `timestamp` (datetime, optional) — The timestamp when the error occurred.
- `request_id` (string, optional) — Correlation identifier for the request, useful for support investigations.
- `errors` (list of ValidationError, optional) — Optional list of individual validation or domain errors.

### 500 Internal Server Error

Internal Server Error

- `type` (string, required) — A URI reference that identifies the problem type. Use 'about:blank' when the problem has no additional semantics beyond the HTTP status code.
- `title` (string, required) — A short, human-readable summary of the problem type.
- `status` (integer, required) — The HTTP status code.
- `detail` (string, optional) — A human-readable explanation specific to this occurrence of the problem.
- `instance` (string, optional) — A URI reference that identifies the specific occurrence of the problem (typically the request path).
- `timestamp` (datetime, optional) — The timestamp when the error occurred.
- `request_id` (string, optional) — Correlation identifier for the request, useful for support investigations.
- `errors` (list of ValidationError, optional) — Optional list of individual validation or domain errors.

## Types

### V1AccountsAccountIdWorkflowsWorkflowIdTriggerRequirementsGetResponsesContentApplicationJsonSchemaTriggerHttpConfig

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.

- `method` (enum, optional) — The HTTP method used to trigger the workflow. This defines the type of request that will initiate the workflow (e.g., GET, POST).
  - Allowed values: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
- `url` (string, optional) — The URL that is associated with the trigger event. This is the endpoint that must be called using the specified HTTP method to start the workflow.

### V1AccountsAccountIdWorkflowsWorkflowIdTriggerRequirementsGetResponsesContentApplicationJsonSchemaTriggerInputSchemaItems

Array of fields required as inputs to trigger the workflow, including field names, data types, and default values.

- `field_name` (string, optional) — The name of the input field expected by the workflow. This key must match the name provided in the `trigger_inputs` when triggering the workflow.
- `field_data_type` (string, optional) — The data type expected for the input field. This indicates whether the input should be a string, number, boolean, object, or array, ensuring the data is passed in the correct format.
- `default_value` (V1AccountsAccountIdWorkflowsWorkflowIdTriggerRequirementsGetResponsesContentApplicationJsonSchemaTriggerInputSchemaItemsDefaultValue, optional) — The default value for the input field if one is provided. This can be a string, number, boolean, object, or array. If no value is provided during the trigger, the workflow may use this default value.

### ResourceMetadata

- `created_at` (datetime, optional) — Timestamp when the agreement document was created.
- `created_by` (string, optional) — User ID of the person who created the agreement document.
- `modified_at` (datetime, optional) — Timestamp when the agreement document was last modified.
- `modified_by` (string, optional) — User ID of the person who last modified the agreement document.

### ValidationError

A single field-level or domain validation error.

- `code` (string, required) — Machine-readable error code.
- `message` (string, required) — Human-readable description of the error.
- `target` (string, optional) — The field or parameter this error relates to.

### V1AccountsAccountIdWorkflowsWorkflowIdTriggerRequirementsGetResponsesContentApplicationJsonSchemaTriggerInputSchemaItemsDefaultValue

The default value for the input field if one is provided. This can be a string, number, boolean, object, or array. If no value is provided during the trigger, the workflow may use this default value.

- string
- double
- boolean
- map from string to any
- list of any

## Examples

**Response**

```json
{
  "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"
  }
}
```