Sign in

v2

latestOpenAPI 3.1.02026-08-064686150.6 KB
Webhooks

Update webhook config

patch/webhooks/configs/{id}

Path parameters

idstring uuid required

Request body

urlstring

New endpoint URL

eventsstring[]

Updated event subscriptions, or ["AllEvents"] to subscribe to all supported event types including ones introduced in the future

Example request

{
  "url": "https://customer.example.com/webhook-v2",
  "events": [
    "EnvelopeCreated"
  ]
}

Response

OK

idstring uuid

Unique identifier

accountIdstring

Account identifier

applicationIdstring

Application identifier

urlstring

Endpoint URL

secretstring

Signing secret (returned on creation and when listing configs)

subscribedEventsstring[]

Subscribed event types, or ["AllEvents"] when subscribed to all

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp