Skip to content

@mbanq/core-sdk-js v0.50.0


@mbanq/core-sdk-js / commands / GetSubscriber

Function: GetSubscriber()

GetSubscriber(subscriberId): Command<{ subscriberId: string; }, { active?: boolean; deliveryRetryLimit?: number; headers?: object[]; id?: number; name: string; secretKey?: string; target?: string; type: "WEBHOOK" | "EMAIL" | "CLIENT_EMAIL" | "PUSH_NOTIFICATION" | "CORE_EVENT_PROCESSOR"; }>

Defined in: src/commands/rest/notification.ts:34

Retrieves detailed information about a specific subscriber.

Parameters

subscriberId

string

The ID of the subscriber to retrieve

Returns

Command<{ subscriberId: string; }, { active?: boolean; deliveryRetryLimit?: number; headers?: object[]; id?: number; name: string; secretKey?: string; target?: string; type: "WEBHOOK" | "EMAIL" | "CLIENT_EMAIL" | "PUSH_NOTIFICATION" | "CORE_EVENT_PROCESSOR"; }>

A Command that when executed returns the subscriber details

Example

typescript
const getSubscriberCmd = GetSubscriber('subscriber-123');
const subscriber = await getSubscriberCmd.execute(config);
console.log(subscriber);

Released under the MIT License.