@justpush.io/justpush-js-sdk v1.2.0

JustPush - JavaScript SDK

Welcome to the official JavaScript SDK for JustPush! This SDK allows you to easily integrate with our powerful messaging platform, providing functionalities to create messages, retrieve messages, create topics, and update topics.

Features

• Create Messages: Send messages effortlessly using our streamlined API.
• Retrieve Messages: Fetch messages with ease for seamless integration and processing.
• Create Topics: Organize your messages by creating specific topics.
• Update Topics: Modify existing topics to keep your message structure flexible and up-to-date.

Download the App in the App Stores

Installation

Install the SDK via npm:

npm i @justpush.io/justpush-js-sdk

Basic Push Message

This is a basic example of sending a notification.

const response = await JustPushMessage.token("REPLACE_WITH_USER_TOKEN")
  .message("Here is a sample Message")
  .title("Test Title")
  .create();

JustPush Message

Defining the topic

Our goals it to keep the API as simple as possible. Therefore, you can send either:

• Topic Title - When the title exists more than once, the oldest topic will be used. If the name is not in your topic list, a new topic will be created.
• Topic UUID - Uses the exact match of the topic

Sending multiple images

When a message contains multiple images, the first image will be used for the push message banner.

Using Button Groups

You can organize buttons into groups, each with its own name and call-to-action. Here's an example:

const response = await JustPushMessage.token("REPLACE_WITH_USER_TOKEN")
  .topic("TestTopic")
  .title("Test Title")
  .message("Here is a message with button groups")
  .buttonGroups([
    {
      name: "Group 1",
      cta: "Group 1 Cta",
      action_required: true,
      buttons: [
        {
          cta: "Button 1",
          url: "https://google.com",
          action_required: true,
        },
        {
          cta: "Button 2",
          url: "https://google.com",
          action_required: true,
        },
      ],
    },
    {
      name: "Group 2",
      cta: "Group 2 Cta",
      action_required: true,
      buttons: [
        {
          cta: "Button 1",
          url: "https://google.com",
          action_required: true,
        },
        {
          cta: "Button 2",
          url: "https://google.com",
          action_required: true,
        },
      ],
    },
  ])
  .create();

Button Group Object Fields

Each button group object has the following fields:

Each button in the buttons array has these fields:

Setting an Expiry

When a expiry is set, the message will have an TTL in seconds. After the expiry, in seconds, has expired, the message will automatically be hidden.

JustPush Topics

POST / Create A Topic

This is a basic example of creating a topic

const response = await JustPushTopic.token("REPLACE_WITH_USER_TOKEN")
  .title("New Topic")
  .create();

PUT / Update A Topic

This is a basic example of updating a topic

$response = JustPushTopic.token("REPLACE_WITH_USER_TOKEN")
  .topic("REPLACE_WITH_TOPIC_UUID")
  .title("New Topic Title")
  .update();

GET / Get a topic

This is a basic example of creating a topic

const response = await JustPushTopic.token("REPLACE_WITH_USER_TOKEN")
  .topic("REPLACE_WITH_TOPIC_UUID")
  .get();

OpenApi Spec

The package comes with an OpenAPI spec. Which can be found in the docs folder. Click Here

Changelog

• n/a - No changes yet.