updateConfig

Update Webhook Client Config

configIdstring required

Short uuid (length 6) to identify the webhook configuration.

Request body

idstring

namestring required

eventNamestring required

urlstring

creationTimestring

creation timestamp

enabledboolean

enableStaticIPboolean

protectedboolean

When true, indicates this webhook configuration is protected and should not be modified without explicit intent.

status'active' | 'inactive' | 'incomplete'

jsonataExpressionstring

JSONata expression to transform the payload

deliveryMode'json_base64' | 'binary_multipart'

Controls how file data is delivered to the endpoint. Only relevant when the webhook is triggered by a file event. Absent for non-file-event webhooks.

_manifeststring[]

Manifest ID used to create/update the webhook resource

signingSecretstring

Per-webhook signing secret following the Standard Webhooks specification. Only returned once during webhook creation. Use this secret to verify webhook signatures using the webhook-id, webhook-timestamp, and webhook-signature headers.

Example request

{
  "eventName": "CustomerRequest_Created",
  "url": "https://my-partner-service.api.com",
  "httpMethod": "POST",
  "enabled": true,
  "auth": {
    "authType": "BASIC",
    "basicAuthConfig": {
      "username": "secretUsername",
      "password": "secret7825@!"
    }
  },
  "filter": {
    "keyToFilter": "customer_request.productId",
    "supportedValues": [
      "2324245",
      "5253642"
    ]
  }
}

Response

Success - if the config is updated successfully