Sign in
latestOpenAPI 3.1.02026-08-224787152.8 KB

44cfae4dc99b

Webhooks

Create webhook config

post/webhooks/configs

Request body

urlstring required

The customer endpoint URL to deliver webhooks to

eventsstring[] required

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

Example request

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

Response

Created

idstring uuid

Unique identifier

accountIdstring

Account identifier

applicationIdstring

Application identifier

urlstring

Endpoint URL

secretstring

Signing secret, returned only once in the create response; store it securely

subscribedEventsstring[]

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

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp