Target a specific jig with inputs

Target a specific jig with inputs

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

<Description of the endpoint>

Headers

Name	Value
Authorization	Bearer <token> Bearer Token - format: BEARER XXXXXXXXXXXXXX

Body

Configure the following properties in the JSON body:

Name	Type	Description
title	string	Title of the notification.
text	string	Notification message.
jigId	string	Provide the jigId of the jig you want to open when the notification is tapped
inputs	string	Define the values for the jig inputs
scope	string	Can use any of the scopes USR, ORG, SLN, or SLN_GRP
solutionId	string	"{{solutionId}}", available in Jigx Management> Solution Details

JSON body

/{
  "content": {
    "title": "🎉 New product promotion",
    "text": "Check it out now",
    "jigId": "view-promotion-details",
    "screen":"jig",
    "inputs": {
      "promo-code": "x-3654",
      "name": "20% on all Winter stock",
      "price": 34
    }
  },
  "scope": "SLN_GRP",
  "groups": [
    "customers"
  ],
  "solutionId": "{{solutionId}}"
}

Response

200

{
    "organizationId": "{{orgId}}",
    "region": "us-east-1",
    "notificationId": "02817dcd-175c-4d0f-8c47-f1838c8e628c",
    "scope": "ORG",
    "state": "QUEUED",
    "startAt": "2025-04-04T10:06:50.444Z",
    "content": {
        "text": "We released a new version of the app",
        "title": "Update your app",
        "screen": "jig",
        "inputs": {}
    },
    "createdAt": "2025-04-04T10:06:50.444Z",
    "createdBy": "{{userId}}",
    "updatedAt": "2025-04-04T10:06:50.444Z",
    "updatedBy": "{{userId}}"
}

400