Class WebhookUtility

The webhook event utility.

public static class WebhookUtility

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

The BoldSign event header.

public const string BoldSignEventHeader = "X-BoldSign-Event"

The BoldSign signature header.

public const string BoldSignSignatureHeader = "X-BoldSign-Signature"

Parses a JSON string from a BoldSign webhook into a WebhookEvent object.

public static WebhookEvent ParseEvent(string json)

Comparing the hmac signature by request header.

public static void ValidateSignature(string json, string signatureHeader, string secretKey, long tolerance = 300)

json string: The json payload from the webhook request.
signatureHeader string: The signature header (Key name: BoldSignSignatureHeader) from the webhook request.
secretKey string: The webhook secret key.
tolerance long: The timestamp tolerance (defaults to 300 seconds).

ArgumentNullException: Thrown when one of the required input is null or empty.
BoldSignSignatureException: Thrown when there is mismatch in signature comparison.