v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

Integration

Update a Webhook

Replaces the WebhookConfiguration resource.

put/webhooks/{id}

Path parameters

idstring required

Resource identifier

Request body

namestring

activeboolean

urlstring uri

eventsWebhookEvent[]

{"stackTrail":"components:schemas:WebhookConfiguration.WebhookInput-webhook.input.update:properties:parameters","oasType":"schema","type":"unknown"}

Example request

{
  "url": "https://example.com/hook",
  "events": [
    "document.create",
    "document.update"
  ],
  "headers": {
    "Authorization": "Header value",
    "Content-Type": "Header value"
  }
}

Response

WebhookConfiguration resource updated

idstring uuid

namestring

activeboolean

urlstring uri

eventsWebhookEvent[]

parametersstring[]

dateCreatedstring date-time

dateModifiedstring date-time

Example response

{
  "id": "c7ad508b-882d-4874-a00c-4b0eecb66e3d",
  "url": "https://example.com/hook",
  "events": [
    "document.create",
    "document.update"
  ],
  "headers": {
    "Authorization": "Header value",
    "Content-Type": "Header value"
  }
}