Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 2.17 KB

File metadata and controls

19 lines (11 loc) · 2.17 KB

UpdateWebhookRequest

Properties

Name Type Description Notes
url String The url of the webhook where notifications will be sent. URL must be valid, unique and https. [optional]
description String description of the webhook of what it is used for.should not contain special characters. [optional]
events List<WebhookEvent> The events that the webhook will be subscribed to [optional]
enabled Boolean The status of the webhook [optional]
mtls WebhookMtls [optional]
webhookOauthId UUID The id of the OAuth credentials this webhook authenticates with, from `/v1/webhooks_settings/oauth`. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. Send `null` to stop using OAuth for this webhook. Cannot be combined with an `authorization` custom header on the same webhook; a request that would leave both set is rejected. [optional]
customHeaders Map<String, Object> A delta applied to the delivery headers. A header with a value is added or replaced, a header with `null` is deleted, and one you leave out is untouched. A value replaces what is stored under that name rather than adding to it, so an array is the complete new set of lines for that header. Send `customHeaders: null` to clear every header in one call. That does not collide with a `null` value on a name: one names the header to delete, the other names the whole field. Names are case-insensitive, so a `null` under one casing deletes a header stored under another. Same rules as on create: string or non-empty array, `Cookie` and `Authorization` string-only, 10 headers and under 16 KB in the resulting set, the same reserved names, and values write-only. Entries set to `null` do not count towards the limit. `Authorization` cannot be combined with `webhookOauthId`, though one request may add it and detach the credentials together. [optional]