Events Client API

This page documents 7 schema-registry client methods in the events namespace.

cancelEventCopy Anchor Link

Cancel an event created by this account using WhatsApp’s encrypted event edit action.

Signature client.cancelEvent(eventId: string): Promise<boolean>

UsageCopy Anchor Link

const result = await client.cancelEvent("false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<boolean>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

editEventCopy Anchor Link

Edit an event created by this account. Unspecified fields retain their current values; endTime: null removes the end time.

Signature client.editEvent(eventId: string, changes: { description?: string; endTime?: number \| null; location?: string; name?: string; startTime?: number }): Promise<boolean>

UsageCopy Anchor Link

const result = await client.editEvent("false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", {"description":"Updated meetup details"});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<boolean>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getEventCopy Anchor Link

Retrieve an event by message ID from WhatsApp local history. Returns null when absent.

Signature client.getEvent(eventId: string): Promise<WhatsAppEvent \| null>

UsageCopy Anchor Link

const result = await client.getEvent("false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to WhatsAppEvent \| null. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<WhatsAppEvent \| null>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getEventResponsesCopy Anchor Link

Get the latest decrypted RSVP per participant, including responses persisted in WhatsApp local history.

Signature client.getEventResponses(eventId: string): Promise<EventResponse[]>

UsageCopy Anchor Link

const result = await client.getEventResponses("false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to EventResponse[]. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<EventResponse[]>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getEventsCopy Anchor Link

Page through a chat’s locally synced event history, newest first. Pass nextCursor as options.before to retrieve the next page.

Signature client.getEvents(chatId: string, options?: { before?: string; limit?: number }): Promise<EventPage>

UsageCopy Anchor Link

const result = await client.getEvents("447123456789@c.us");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to EventPage. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<EventPage>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

respondToEventCopy Anchor Link

RSVP through WhatsApp’s native encrypted event-response action.

Signature client.respondToEvent(eventId: string, response: "going" \| "notGoing" \| "maybe"): Promise<boolean>

UsageCopy Anchor Link

const result = await client.respondToEvent("false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB", "going");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to boolean. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<boolean>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

sendEventCopy Anchor Link

Send a native WhatsApp event with Unix-second times. Returns its submitted message ID; delivery is observed through ACKs.

Signature client.sendEvent(to: string, event: { callType?: "voice" \| "video"; description?: string; endTime?: number; extraGuestsAllowed?: boolean; isScheduledCall?: boolean; location?: string; name: string; quotedMsgId?: string; requireApproval?: boolean; startTime: number }): Promise<string>

UsageCopy Anchor Link

const result = await client.sendEvent("447123456789@c.us", {"name":"Community meetup","startTime":1893456000,"description":"Meet the community"});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Message ID

In-process Client resolves to Promise<MessageId>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property. Message ID