Options
All
  • Public
  • Public/Protected
  • All
Menu

Wave is a lightweight API that provides customer order updates that can be used on any platform. This data then propagates through the Bluedot Arrival platform, updating user status appropriately and firing any webhooks attached.

Hierarchy

  • Wave

Index

Properties

Properties

send

send: (destinationId: string, customEventMetaData?: HelloModel | CustomEventMetaData, options?: WaveOptions) => Promise<void>

To send a Wave event, pass your destinationId and custom data.

param

destination identifier

param

any custom data fields or a HelloModel object

param

an optional options object containing extra configurable properties

throws

InvalidInputTypeError If destinationId is not a string

throws

RequiredValueMissingError If HelloModel is used and orderId has not been provided

Type declaration

Generated using TypeDoc