NotificationChannels

Channels

The delivery channels and their payloads

Channels

@visulima/notification ships six channels. Each has a typed payload.

SMS

{ to: "+15555550100" | ["+1…", "+1…"], text: "…", from?: "…", mediaUrls?: ["https://…"] }

Providers: twilio, vonage, plivo, messagebird, telnyx.

Push

{ to: "token" | ["t1", "t2"], title?: "…", body: "…", data?: {}, imageUrl?: "…", badge?: 1, sound?: "default" }

Providers: fcm, expo.

Chat

{ text: "…", to?: "channel-id", blocks?: <provider-specific>, threadId?: "…" }

Providers: slack, discord, msteams, telegram.

In-app

{ to: "subscriber-id", title?: "…", body: "…", data?: {}, actions?: [{ label: "Open", url: "…" }] }

Provider: inAppProvider from @visulima/notification/channels/inapp. See Providers.

Webhook

{ body: <json>, url?: "https://…", method?: "POST", headers?: {} }

Provider: webhook.

Email

{ from?: "…", to: "…", subject: "…", html?: "…", text?: "…", cc?, bcc?, replyTo?, attachments? }

The email channel delegates to a @visulima/email Mail instance via emailChannel(mail). See Providers.

Edit on GitHub

On this page

ChannelsSMSPushChatIn-appWebhookEmail
Support

Contribute to our work and keep us going

Community is the heart of open source. The success of our packages wouldn't be possible without the incredible contributions of users, testers, and developers who collaborate with us every day.Want to get involved? Here are some tips on how you can make a meaningful impact on our open source projects.

Ready to help us out?

Be sure to check out the package's contribution guidelines first. They'll walk you through the process on how to properly submit an issue or pull request to our repositories.

Submit a pull request

Found something to improve? Fork the repo, make your changes, and open a PR. We review every contribution and provide feedback to help you get merged.

Good first issues

Simple issues suited for people new to open source development, and often a good place to start working on a package.
View good first issues