Sign in

v2

latestOpenAPI 3.1.02026-08-064686150.6 KB
Webhooks

List supported webhook event types

Returns the event types a webhook config can subscribe to, in envelope lifecycle order. To subscribe to all of them - including event types introduced in the future - send ["AllEvents"] as the config's events instead of an explicit list.

get/webhooks/configs/event-types

Response

OK

eventTypesstring[]

Event types supported for webhook subscriptions, in envelope lifecycle order. Subscribe to all of them (including types added in the future) by sending ["AllEvents"] as the subscription instead of an explicit list.

Example response

{
  "eventTypes": [
    "EnvelopeCreated",
    "EnvelopeSentForSignature",
    "EnvelopeSigningCompleted"
  ]
}