Returns the configuration for the webhook identified in the path.
To make this request, your API credential must have one of the following roles:
Unique identifier of the company account.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
The request has succeeded.
Show more Show lessReferences to resources connected with this webhook.
The company account that the webhook is configured for. Only present for company-level webhooks.
The merchant account that the webhook is configured for. Only present for merchant-level webhooks.
Indicates if expired SSL certificates are accepted. Default value: false.
Indicates if self-signed SSL certificates are accepted. Default value: false.
Indicates if untrusted SSL certificates are accepted. Default value: false.
Indicates if the webhook configuration is active. The field must be true for you to receive webhooks about events related an account.
Additional shopper and transaction information to be included in your standard notifications. Find out more about the available additional settings.
Object containing list of event codes for which the notifcation will not be sent.
Object containing list of event codes for which the notifcation will be sent.
Object containing boolean key-value pairs. The key can be any standard webhook additional setting, and the value indicates if the setting is enabled.
For example, captureDelayHours: true means the standard notifications you get will contain the number of hours remaining until the payment will be captured.
The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.
Format or protocol for receiving webhooks. Possible values:
Shows how merchant accounts are included in company-level webhooks. Possible values:
filterMerchantAccounts.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:
Not needed for filterMerchantAccountType: allAccounts.
Indicates if the webhook configuration has errors that need troubleshooting. If the value is true, troubleshoot the configuration using the testing endpoint.
The checksum of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook.
Indicates if the SOAP action header needs to be populated. Default value: false.
Only applies if communicationFormat: soap.
SSL version to access the public webhook URL specified in the url field. Possible values:
If not specified, the webhook will use sslVersion: TLSv1.2.
The type of webhook. Possible values are:
Find out more about standard notification webhooks and other types of notifications.
Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.