Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 3.63 KB

UpdateCompanyWebhookRequest.md

File metadata and controls

52 lines (39 loc) · 3.63 KB

UpdateCompanyWebhookRequest

Properties

Name Type Description Notes
acceptsExpiredCertificate kotlin.Boolean Indicates if expired SSL certificates are accepted. Default value: false. [optional]
acceptsSelfSignedCertificate kotlin.Boolean Indicates if self-signed SSL certificates are accepted. Default value: false. [optional]
acceptsUntrustedRootCertificate kotlin.Boolean Indicates if untrusted SSL certificates are accepted. Default value: false. [optional]
active kotlin.Boolean Indicates if the webhook configuration is active. The field must be true for us to send webhooks about events related an account. [optional]
additionalSettings AdditionalSettings [optional]
communicationFormat inline Format or protocol for receiving webhooks. Possible values: * soap * http * json [optional]
description kotlin.String Your description for this webhook configuration. [optional]
encryptionProtocol inline SSL version to access the public webhook URL specified in the `url` field. Possible values: * TLSv1.3 * TLSv1.2 * HTTP - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: TLSv1.2. [optional]
filterMerchantAccountType inline Shows how merchant accounts are filtered when configuring the webhook. Possible values: * includeAccounts: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. * excludeAccounts: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. * allAccounts: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`. [optional]
filterMerchantAccounts kotlin.collections.List<kotlin.String> A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`. Required if `filterMerchantAccountType` is either: * includeAccounts * excludeAccounts Not needed for `filterMerchantAccountType`: allAccounts. [optional]
networkType inline Network type for Terminal API notification webhooks. Possible values: * public * local Default Value: public. [optional]
password kotlin.String Password to access the webhook URL. [optional]
populateSoapActionHeader kotlin.Boolean Indicates if the SOAP action header needs to be populated. Default value: false. Only applies if `communicationFormat`: soap. [optional]
url kotlin.String Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint. [optional]
username kotlin.String Username to access the webhook URL. [optional]

Enum: communicationFormat

Name Value
communicationFormat http, json, soap

Enum: encryptionProtocol

Name Value
encryptionProtocol HTTP, TLSv1.2, TLSv1.3

Enum: filterMerchantAccountType

Name Value
filterMerchantAccountType allAccounts, excludeAccounts, includeAccounts

Enum: networkType

Name Value
networkType local, public