External push notifications (API)

External push notifications are messages sent from a backend system or third-party service to a mobile application, without any action required from within the app itself. These notifications are essential for delivering timely updates, alerts, and personalized content that enhance user engagement and keep your app connected to external workflows and systems.

When using the Jigx API, external push notifications are triggered through a dedicated notification endpoint, which allows for flexible targeting across multiple levels of your app’s user base. The endpoint supports four scopes for delivering messages:

  • USR (Users) – Target specific individual users.

  • SLN (Solution)– Notify all users within a particular solution.

  • SLN_GRP (Solution Groups) – Send messages to predefined groups within a solution.

  • ORG (Organization) – Broadcast notifications to all users across the entire organization.

This scope-based approach gives you and system integrators fine-grained control over who receives what message, making it easy to tailor communication for different roles, departments, or use cases.

API Notification Endpoint

POST
POST {{baseURL}}/tool/organizations/{{orgId}}/notifications

Base URL

Replace {{baseUrl}} with the appropriate URL for your region.

Functional Areas

Area
URL
Description

tool

{{baseURL}}/tool

Endpoint covering: - notifications - members

Authentication

  • A Personal Access Token (PAT) is required. Get your PAT from My profile in Jigx Management.

  • Enter the PAT as an API key with the prefix BEARER, for example, BEARER XXXXXXXXXX.

Responses

201 Created 401 Unauthorized

JSON elements

Element
Where to find it

organizationId

In Jigx Management under organization settings.

solutionId

In Jigx Management under solution settings

baseURL

Refer to the Base URL table above to find the URL for your region.

scope

- USR – Target specific individual users. - SLN – Notify all users within a particular solution. - SLN_GRP – Send messages to predefined groups within a solution. - ORG – Broadcast notifications to all users across the entire organization.

jigId

Target a specific jig with input parameters.When the user taps on the notification (either on the native push notification or the in-app notification), the app will navigate to the specific jig.

screen

Default value = "jig"

title

Title that shows in the notification message.

text

Subtitle text displays under the title in the notification message.

inputs

Provide the input parameters to send into the jig specified in the jigId property.

emails

Specific the users' email addresses (array) to send the notification to.

Examples and code snippets

Last updated

Was this helpful?