Class SmsCallbackWebhooks

Index

Constructors

Methods

parseEvent validateAuthenticationHeader parseEvent

Constructors

constructor

new SmsCallbackWebhooks(appSecret?: string): SmsCallbackWebhooks
Parameters
- OptionalappSecret: string
Returns SmsCallbackWebhooks

Methods

parseEvent

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

validateAuthenticationHeader

validateAuthenticationHeader(
    headers: IncomingHttpHeaders,
    body: any,
    _path?: string,
    _method?: string,
): boolean
Parameters
- headers: IncomingHttpHeaders
- body: any
- Optional_path: string
- Optional_method: string
Returns boolean
Implementation of CallbackProcessor.validateAuthenticationHeader

`Static`parseEvent

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