CreateWebhookInput
Create, echo the unsigned validation token, then bind this webhook to a channel with the required event subscriptions. Normal event delivery requires an active webhook and an enabled channel binding. Validation accepts any 2xx response containing the token within 10 seconds.
oneOf- object
- object
Display name for the webhook (not unique)
Possible values: <= 50 characters
Must be HTTPS. Omit when authenticationProtocol is 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
Required for Chatt2MeForSalesforce. Must be an HTTPS Salesforce origin ending in .my.salesforce.com without path, query, fragment, credentials, or port.
Possible values: <= 255 characters
https://company.my.salesforce.comAuthentication 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]
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
Possible values: non-empty and <= 255 characters
Possible values: non-empty and <= 255 characters
{
"label": "string",
"endpoint": "string",
"salesforceDomain": "https://company.my.salesforce.com",
"authenticationProtocol": "NoAuthentication",
"requiresSignature": true,
"headers": [
{
"key": "string",
"value": "string"
}
]
}