UpdateWebhookInput

Endpoint or protocol changes, supplied headers, or active:true trigger revalidation; unchanged URL alone does not. Validation failure deactivates the webhook.

labelstring

Display name for the webhook (not unique)

Possible values: <= 50 characters

endpointstring<uri>

Must be HTTPS. Required when switching away from Chatt2MeForSalesforce. HTTPS destinations must resolve only to public addresses. Validation, delivery and OAuth token requests do not follow redirects or use environment proxies. Response bodies are limited to 256 KiB; outbound request bodies to 2 MiB.

Possible values: <= 255 characters

salesforceDomainstring<uri>

Required when switching to Chatt2MeForSalesforce; omit to retain the current domain when already using that protocol.

Possible values: <= 255 characters

Example: https://company.my.salesforce.com

authenticationProtocolAuthenticationProtocol

Authentication of the receiving webhook endpoint, distinct from the Hub client x-api-key. Configure protocol credentials through webhook headers; NoAuthentication uses no receiver authentication; BasicAuthentication uses username/password, JWT uses a bearer token, Oauth20 obtains a token, and Chatt2MeForSalesforce uses the configured Salesforce integration. Use the documented X-Basic-, X-JWT-Token or X-OAuth- configuration headers. New configuration normalizes generated Authorization; supplying a manual Authorization header does not override the selected protocol. Salesforce rejects Authorization and X-OAuth-* with RESERVED_SALESFORCE_AUTH_HEADER.

Possible values: [NoAuthentication, Oauth20, BasicAuthentication, JWT, Chatt2MeForSalesforce]

requiresSignatureboolean

On PATCH, true generates a new signing secret even if already enabled. Store the returned secret; omission preserves the current setting.

headers object[]

Receiver headers. On PATCH, omission preserves headers; an empty array clears them; a supplied array replaces all existing headers.

Possible values: <= 30

Array [

keystringrequired

Possible values: non-empty and <= 255 characters

valuestringrequired

Possible values: non-empty and <= 255 characters

]

activeboolean

true triggers endpoint revalidation; a failed validation leaves the webhook inactive.

UpdateWebhookInput

{
  "label": "string",
  "endpoint": "string",
  "salesforceDomain": "https://company.my.salesforce.com",
  "authenticationProtocol": "NoAuthentication",
  "requiresSignature": true,
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "active": true
}