com.sendgrid.helpers.eventwebhook

Class EventWebhook

java.lang.Object

com.sendgrid.helpers.eventwebhook.EventWebhook

public class EventWebhook
extends Object

This class allows you to easily use the Event Webhook feature. Read the docs for more details: https://sendgrid.com/docs/for-developers/tracking-events/event.

Constructor Summary

Constructors

Constructor and Description
EventWebhook()

Method Summary

Modifier and Type	Method and Description
ECPublicKey	ConvertPublicKeyToECDSA(String publicKey) Convert the public key string to a ECPublicKey.
boolean	VerifySignature(ECPublicKey publicKey, byte[] payload, String signature, String timestamp) Verify signed event webhook requests.
boolean	VerifySignature(ECPublicKey publicKey, String payload, String signature, String timestamp) Verify signed event webhook requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventWebhook

public EventWebhook()

Method Detail

ConvertPublicKeyToECDSA

public ECPublicKey ConvertPublicKeyToECDSA(String publicKey)
                                    throws NoSuchAlgorithmException,
                                           NoSuchProviderException,
                                           InvalidKeySpecException

Convert the public key string to a ECPublicKey.

Parameters:

publicKey: - verification key under Mail Settings

Returns:

a public key using the ECDSA algorithm

Throws:

NoSuchAlgorithmException

NoSuchProviderException

InvalidKeySpecException

VerifySignature

public boolean VerifySignature(ECPublicKey publicKey,
                               String payload,
                               String signature,
                               String timestamp)
                        throws NoSuchAlgorithmException,
                               NoSuchProviderException,
                               InvalidKeyException,
                               SignatureException,
                               IOException

Verify signed event webhook requests.

Parameters:

publicKey: - elliptic curve public key

payload: - event payload string in the request body

signature: - value obtained from the 'X-Twilio-Email-Event-Webhook-Signature' header

timestamp: - value obtained from the 'X-Twilio-Email-Event-Webhook-Timestamp' header

Returns:

true or false if signature is valid

Throws:

NoSuchAlgorithmException

NoSuchProviderException

InvalidKeyException

SignatureException

IOException

VerifySignature

public boolean VerifySignature(ECPublicKey publicKey,
                               byte[] payload,
                               String signature,
                               String timestamp)
                        throws NoSuchAlgorithmException,
                               NoSuchProviderException,
                               InvalidKeyException,
                               SignatureException,
                               IOException

Verify signed event webhook requests.

Parameters:

publicKey: - elliptic curve public key

payload: - event payload bytes in the request body

signature: - value obtained from the 'X-Twilio-Email-Event-Webhook-Signature' header

timestamp: - value obtained from the 'X-Twilio-Email-Event-Webhook-Timestamp' header

Returns:

true or false if signature is valid

Throws:

NoSuchAlgorithmException

NoSuchProviderException

InvalidKeyException

SignatureException

IOException