Class VerificationCallbackWebhooks

Index

Constructors

Methods

parseEvent validateAuthenticationHeader parseEvent

Constructors

constructor

new VerificationCallbackWebhooks(
sinchClientParameters: SinchClientParameters,
): VerificationCallbackWebhooks
Parameters
- sinchClientParameters: SinchClientParameters
Returns VerificationCallbackWebhooks

Methods

parseEvent

parseEvent(eventBody: any): VerificationCallbackEvent
Reviver for a Verification Event. This method ensures the object can be treated as a Verification Event and should be called before any action is taken to manipulate the object.
Parameters
- eventBody: any
  The event body containing the verification event notification.
Returns VerificationCallbackEvent
- The parsed verification event object.
Implementation of CallbackProcessor.parseEvent

validateAuthenticationHeader

validateAuthenticationHeader(
    headers: IncomingHttpHeaders,
    body: any,
    path: string,
    method: string,
): boolean
Validate authorization header for callback request
Parameters
- headers: IncomingHttpHeaders
  Incoming request's headers
- body: any
  Incoming request's body
- path: string
  Incoming request's path
- method: string
  Incoming request's HTTP method
Returns boolean
- true if the authorization header is valid
Implementation of CallbackProcessor.validateAuthenticationHeader

`Static`parseEvent

parseEvent(eventBody: any): VerificationCallbackEvent
Static reviver for a Verification Event. This method ensures the object can be treated as a Verification Event.
Parameters
- eventBody: any
  The event body containing the Verification event notification.
Returns VerificationCallbackEvent
- The parsed Verification event object