patch
https://api.mesh.complyadvantage.com/v2/notifications/configurations/webhook/
Updates the name, URL or active state of a webhook configuration.
URL checks
The checks run on the new URL when you change the URL, and on the stored URL when you set is_active to true on an inactive configuration. Other updates run no check.
This endpoint checks the URL in the order below. If a check fails, you get a 400, the remaining checks do not run, and the configuration is not changed.
- The scheme must be
httporhttps. Otherwise, the error key iserror.validation.WebhookUrlScheme. Scheme names are not case-sensitive. - The URL must be valid. Otherwise, the error key is
error.validation.ValidWebhookUrl. - An
httpURL requiresallow_insecure_httpset totrue. Otherwise, the error key iserror.validation.WebhookUrlScheme. - This endpoint sends one
HEADrequest to your URL:- If the host resolves only to IANA special-purpose IPv4 addresses, no request is sent and the error key is
error.validation.ValidWebhookUrl. - If the server presents a TLS certificate that is expired, untrusted, or does not match the host name, the error key is
error.validation.WebhookCertificate. - If the request gets no HTTP response, the error key is
error.validation.WebhookUrlUnreachable. This covers a host name that does not resolve, a refused or timed-out connection, and a TLS handshake that fails for a reason other than the certificate (for example, a server that only supports TLS versions below 1.2). - Any HTTP status code passes, because the server responded.
- If the host resolves only to IANA special-purpose IPv4 addresses, no request is sent and the error key is
http and https
We recommend an https URL. Webhooks to an https URL use TLS 1.2 or higher.
To change the URL to an http URL, or to activate a webhook with an http URL, set allow_insecure_http to true. Other updates ignore the field. The traffic is unencrypted.
Permissions
You need the "Create and update webhooks" permission to use this endpoint.