Webhooks

One webhook

GET
/v1/workspaces/{workspace_id}/webhooks/{webhook_id}

A subscription and its state.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from /v1/auth/token, or a personal token: opaque, beginning s2a_.

Path Parameters

workspace_id*string

wsp_…, from GET /v1/me

Lengthlength <= 40
webhook_id*string
Lengthlength <= 40

Response Body

The webhook

application/json
  1. response

The webhook

id*string

whk_…

url*string
events*array<>
document_type_ids?array<string>

Envelope events only for these document types; left out: all

description?string
status*string

failing after 24 hours without a delivery; it comes back with the next one

Value in"active""failing""disabled"
failing_since?string

When it began failing

Formatdate-time
previous_secret_until?string

Until when the secret it replaced still signs too

Formatdate-time
scopes*array<>

The read scopes it was made with that add detail: documents:envelopes:read adds titles, reference values (never a sensitive one) and recipients’ names; people:read a person’s name. IDs, state, times and external_id are always sent.

created_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
curl -X GET 'https://api.sign2approve.com/v1/workspaces/string/webhooks/string'
{  "id": "whk_01a16d3fd3507be78e41c4540aa20a3c",  "url": "https://hooks.example.com/esign",  "events": [    "envelope.completed",    "timeoff.approved"  ],  "status": "active",  "scopes": [    "documents:envelopes:read"  ],  "created_at": "2026-10-24T09:30:00Z"}