Update a webhook

Update a previously created webhook.

Request
path Parameters
webhookId
required
string <uuid>

Identifier of a previously created webhook.

Request Body schema: application/json
url
string <uri>

The URL we will make an HTTP POST request to when an event of type occurs.

secret
string

An optional secret which will be passed in the X-Secret header to the webhook callback URL.

allowInsecureUrl
boolean

Set to true to allow insecure callback URLs such as URLs without SSL or URLs with self signed certificates.

includeSensitiveInfo
boolean

If set to false, the sensitive info will be masked in the webhook payload. The default value is true.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

patch/webhooks/{webhookId}
Request samples
application/json
{
  • "url": "http://example.com",
  • "secret": "string",
  • "allowInsecureUrl": true,
  • "includeSensitiveInfo": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "VerificationCompleted",
  • "url": "http://example.com",
  • "allowInsecureUrl": true,
  • "includeSensitiveInfo": true
}