Verdocs - Update organization Webhooks config

Note that Webhooks cannot currently be deleted, but may be easily disabled by setting

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

url*string

URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.

active*boolean

Set to true to enable Webhooks calls.

auth_method?string

Enable HMAC or Client Credentials authentication for Webhooks calls.

Value in"none" | "hmac" | "client_credentials"

token_endpoint?string

Required if auth_method is set to client_credentials. Token endpoint to use for authenticating Webhooks calls.

client_id?string

Required if auth_method is set to client_credentials. Client ID to use for authenticating Webhooks calls.

client_secret?string

Required if auth_method is set to client_credentials. Client secret to use for authenticating Webhooks calls.

scope?string

Optional scope to include in authentication calls if auth_method is set to client_credentials.

events*object

Record<TWebhookEvent, boolean> map of events to enable/disable.

Response Body

`application/json`

curl -X PATCH "https://api.verdocs.com/v2/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "string",    "active": true,    "events": {}  }'

{}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

Update organization Webhooks config

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`