com.squareup.square.utilities

Class WebhooksHelper

java.lang.Object

com.squareup.square.utilities.WebhooksHelper

public class WebhooksHelper
extends Object

Utility to help with Square Webhooks

Constructor Summary

Constructors

Constructor and Description
WebhooksHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	isValidWebhookEventSignature(String requestBody, String signatureHeader, String signatureKey, String notificationUrl) Verifies and validates an event notification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhooksHelper

public WebhooksHelper()

Method Detail

isValidWebhookEventSignature

public static boolean isValidWebhookEventSignature(String requestBody,
                                                   String signatureHeader,
                                                   String signatureKey,
                                                   String notificationUrl)

Verifies and validates an event notification. See the documentation for more details.

Parameters:

requestBody - The JSON body of the request.

signatureHeader - The value for the x-square-hmacsha256-signature header.

signatureKey - The signature key from the Square Developer portal for the webhook subscription.

notificationUrl - The notification endpoint URL as defined in the Square Developer portal for the webhook subscription.

Returns:

true if the signature is valid, indicating that the event can be trusted as it came from Square.
false if the signature validation fails, indicating that the event did not come from Square, so it may be malicious and should be discarded.