Integration

Update a Webhook

Replaces the WebhookConfiguration resource.

put/webhooks/{id}

Request

  • Base URL
    https://{instance_name}.quable.com/api
  • URL
    https://{instance_name}.quable.com/api/webhooks/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Resource identifier

Request body

@idstring
@typestring
namestring
activeboolean
urlstring uri
eventsWebhookEvent[]
parametersunknown

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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.