On this page
No Headings
A verify webhook signature request.
objectauth_algorequiredstring^[a-zA-Z0-9]+$The algorithm that PayPal uses to generate the signature and that you can use to verify the signature. Extract this value from the PAYPAL-AUTH-ALGO response header, which is received with the webhook notification.
cert_urlrequiredstringuriThe X.509 public key certificate. Download the certificate from this URL and use it to verify the signature. Extract this value from the PAYPAL-CERT-URL response header, which is received with the webhook notification.
transmission_idrequiredstring^(?!\d+$)\w+\S+The ID of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-ID header of the notification message.
transmission_sigrequiredstring^(?!\d+$)\w+\S+The PayPal-generated asymmetric signature. Appears in the PAYPAL-TRANSMISSION-SIG header of the notification message.
transmission_timerequiredstringdate-timeThe date and time of the HTTP transmission, in Internet date and time format. Appears in the PAYPAL-TRANSMISSION-TIME header of the notification message.
webhook_idrequiredstring^[a-zA-Z0-9]+$The ID of the webhook as configured in your Developer Portal account.
webhook_eventrequiredobjectA webhook event notification.
idstringThe ID of the webhook event notification.
create_timestringdate-timeThe date and time when the webhook event notification was created, in Internet date and time format.
resource_typestringThe name of the resource related to the webhook notification event.
event_versionstring^([0-9]+.[0-9]+)$The event version in the webhook notification.
event_typestringThe event that triggered the webhook event notification.
summarystringA summary description for the event notification.
resource_versionstring^([0-9]+.[0-9]+)$The resource version in the webhook notification.
resourceobjectThe resource that triggered the webhook event notification.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.