POST /v1/notifications/verify-webhook-signature

Verifies a webhook signature.

Servers

https://api-m.sandbox.paypal.com
https://api-m.paypal.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`transmission_sig`	String	Yes	The PayPal-generated asymmetric signature. Appears in the `PAYPAL-TRANSMISSION-SIG` header of the notification message.
`auth_algo`	String	Yes	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.
`transmission_id`	String	Yes	The ID of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-ID` header of the notification message.
`transmission_time`	String	Yes	The date and time of the HTTP transmission, in Internet date and time format. Appears in the `PAYPAL-TRANSMISSION-TIME` header of the notification message.
`cert_url`	String	Yes	The 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.
`webhook_event`	Object	Yes	A webhook event notification.
`webhook_event.id`	String	No	The ID of the webhook event notification.
`webhook_event.create_time`	String	No	The date and time when the webhook event notification was created, in Internet date and time format.
`webhook_event.resource_type`	String	No	The name of the resource related to the webhook notification event.
`webhook_event.resource_version`	String	No	The resource version in the webhook notification.
`webhook_event.event_type`	String	No	The event that triggered the webhook event notification.
`webhook_event.resource`	Object	No	The resource that triggered the webhook event notification.
`webhook_event.event_version`	String	No	The event version in the webhook notification.
`webhook_event.summary`	String	No	A summary description for the event notification.
`webhook_event.links[]`	Array	No	An array of request-related HATEOAS links.
`webhook_event.links[].href`	String	Yes	The 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.
`webhook_event.links[].method`	String	No	The HTTP method required to make the related call. Possible values: `"OPTIONS"` `"POST"` `"PUT"` `"DELETE"` `"HEAD"` `"CONNECT"` `"GET"` `"PATCH"`
`webhook_event.links[].rel`	String	Yes	The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
`webhook_id`	String	Yes	The ID of the webhook as configured in your Developer Portal account.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.