API template library

Simulate the DocuSign Workflow Builder API

A WireMock simulation of DocuSign's REST API — covering Maestro workflows and their trigger requirements, pausing and resuming, triggering instances over HTTP, instance progress and cancellation, and account-wide instance history.

Vendor
DocuSign
Functionality
Workflows, triggers, instance tracking
Spec version
1.0.0
Endpoints
9
Stubs
72
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real DocuSign API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

DocuSign Workflow Builder API

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://9em3v6.wiremockapi.cloud

GET List workflows and their status

curl -s -X GET 'https://9em3v6.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/workflows' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

POST Trigger Customer Onboarding

curl -s -X POST 'https://9em3v6.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/workflows/47a0367b-5c1d-4e2f-8a9b-5eceefed344d/actions/trigger' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"instance_name":"Onboarding - Bloom & Branch","trigger_inputs":{"signer_name":"Rae Kim","signer_email":"rae.kim@example.com"}}'

GET List failed instances across the account

curl -s -X GET 'https://9em3v6.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/workflow-instances?status=Failed' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Method Path Summary
GET /v1/accounts/{accountId}/workflow-instances Get Workflow Instances for Account
GET /v1/accounts/{accountId}/workflows Retrieve a list of available Workflow Builder workflows
POST /v1/accounts/{accountId}/workflows/{workflowId}/actions/pause Pause an Active Workflow
POST /v1/accounts/{accountId}/workflows/{workflowId}/actions/resume Resume a Paused Workflow
POST /v1/accounts/{accountId}/workflows/{workflowId}/actions/trigger Trigger a new instance of a Workflow Builder workflow
GET /v1/accounts/{accountId}/workflows/{workflowId}/instances Retrieve All Workflow Instances
GET /v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId} Retrieve a Workflow Instance
POST /v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId}/actions/cancel Cancel a Running Workflow Instance
GET /v1/accounts/{accountId}/workflows/{workflowId}/trigger-requirements Get trigger requirements for a workflow

Unauthenticated WireMock Cloud demo sandbox for DocuSign — not an official DocuSign sandbox, and it returns simulated example data only.

What's inside the Workflow Builder template

Workflow Builder, the API formerly known as Maestro, starts and tracks the multi-step agreement workflows a DocuSign admin designs. Lucky Shrub Sales has four of them, one per lifecycle state: Customer Onboarding and Vendor NDA Intake are active, Annual Contract Renewal is paused, and Legacy Purchase Approval is inactive. Trigger requirements describe each one's input schema with defaults, such as account_tier falling back to Standard. Instances report progress as last_completed_step against total_steps, so the seeded Globex onboarding sits at step 2 of 4 on Send onboarding agreement, while Initech's was canceled after step 1.

  • Workflows — the account's workflow definitions with active, paused and inactive statuses
  • Trigger requirements — trigger id, HTTP method and input schema with defaults for each workflow
  • Lifecycle controls — pause and resume, with conflict responses for invalid transitions
  • Instances — trigger with instance_name and trigger_inputs, read progress step by step, cancel while running
  • Instance history — account-wide instances filtered by starter, workflow and status, paged with ctoken

DocuSign Workflow Builder mock API FAQ

Within two reads. The trigger answers 201 with an instance_id; the first GET shows it In Progress with step 1 done, and the second shows it Completed with all four steps done and ended_at set. That's enough to run a polling loop to completion in a unit test without sleeps.

Leaving out a required input answers 400 with REQUIRED_INPUT_MISSING and a target such as trigger_inputs.signer_email. Triggering the paused renewal workflow answers 400 because it isn't active, and Vendor NDA Intake answers 400 too, since it starts from a link rather than an API call.

For state conflicts. Pausing a workflow that isn't active, resuming one that isn't paused, and cancelling an instance that has already completed, failed or been canceled all answer 409 Conflict. Only an In Progress instance, such as a fresh trigger or the seeded Globex run, can be canceled.

No, because the API itself has no such operation: workflows are built in the DocuSign web designer. The four seeded definitions are the whole set. Instances you trigger are shared with every sandbox visitor, any Bearer token is accepted, and a missing header answers 401.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.