Webhooks
One webhook
GET
A subscription and its state.
bearerheader
AuthorizationBearer <token>An access token from /v1/auth/token, or a personal token: opaque, beginning s2a_.
workspace_id*stringwsp_…, from GET /v1/me
Length
length <= 40webhook_id*stringLength
length <= 40The webhook
application/json- response
The webhook
id*stringwhk_…
url*stringevents*array<>document_type_ids?array<string>Envelope events only for these document types; left out: all
description?stringstatus*stringfailing after 24 hours without a delivery; it comes back with the next one
Value in
"active""failing""disabled"failing_since?stringWhen it began failing
Format
date-timeprevious_secret_until?stringUntil when the secret it replaced still signs too
Format
date-timescopes*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*stringMatch
^(?:(?:\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)))$Format
date-timecurl -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"}