JustPush.postman_collection.json

{
	"info": {
		"_postman_id": "eb82cce8-5c8a-452b-93c8-328fe318e636",
		"name": "JustPush",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
		"_exporter_id": "34890749"
	},
	"item": [
		{
			"name": "Messages",
			"item": [
				{
					"name": "Title Only",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"user\": \"{{user_key}}\",\n    \"title\": \"A simple title\"\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The \"title\" in the JustPush notification system is an optional field that appears as a headline for the message. If not provided, the app’s name is used by default. It should be concise, clear, and engaging, and can include emojis. While it’s not required, omitting it may reduce message clarity. The title has a character limit of 255 and helps make notifications more recognizable and relevant. Avoid vague titles like \"Message\" or \"Notification.\""
					},
					"response": []
				},
				{
					"name": "Title & Message",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"user\": \"{{user_key}}\",\n    \"title\": \"A simple title\",\n    \"message\": \"A simple test message\"\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The \"message\" field is where you input the main content of the notification, such as alerts, reminders, or updates. It supports plain text with line breaks and emojis but no HTML, markdown, or rich formatting. There’s no strict length limit, but shorter, scannable content is recommended. The message should be clear and to the point, avoiding long paragraphs or excessive details like logs. Examples include alerts (\"Server CPU at 95%!\"), reminders (\"Water the plants today!\"), and status updates (\"Your order has shipped!\")."
					},
					"response": []
				},
				{
					"name": "Title & Message, Priority",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"user\": \"{{user_key}}\",\n    \"title\": \"A simple title\",\n    \"message\": \"A simple test message\",\n    \"priority\": \"2\"\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The **Sounds** object in JustPush.io defines the custom notification sound associated with a push message. By default, messages use the system notification sound, but specifying a sound in the message payload allows for a more personalized experience. The `sound` property accepts a predefined sound name or a custom uploaded file, ensuring that critical notifications stand out. If no sound is specified, the default system sound is used. This feature is particularly useful for differentiating between urgent alerts, promotional messages, or user-specific notifications, enhancing engagement and recognition.\n\n### Be aware\nIn this example, we have used the HIGHEST priortiy. "
					},
					"response": []
				},
				{
					"name": "Title & Message, Custom Sound",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"user\": \"{{user_key}}\",\n    \"title\": \"A simple title\",\n    \"message\": \"A simple test message\",\n    \"sound\": \"COSMIC\"\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The **Sounds** object in JustPush.io defines the custom notification sound associated with a push message. By default, messages use the system notification sound, but specifying a sound in the message payload allows for a more personalized experience. The `sound` property accepts a predefined sound name or a custom uploaded file, ensuring that critical notifications stand out. If no sound is specified, the default system sound is used. This feature is particularly useful for differentiating between urgent alerts, promotional messages, or user-specific notifications, enhancing engagement and recognition.\n\n### Be aware\nIn this example, we have used the HIGHEST priortiy. "
					},
					"response": []
				},
				{
					"name": "Title & Message, Image",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n        \"user\": \"{{user_key}}\",\n    \"title\": \"A simple title\",\n    \"message\": \"A simple test message\",\n    \"images\": [\n        {\n            \"url\": \"https://picsum.photos/800/600\",\n            \"caption\": \"Thanks Picsum\"\n        }\n    ]\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The **Sounds** object in JustPush.io defines the custom notification sound associated with a push message. By default, messages use the system notification sound, but specifying a sound in the message payload allows for a more personalized experience. The `sound` property accepts a predefined sound name or a custom uploaded file, ensuring that critical notifications stand out. If no sound is specified, the default system sound is used. This feature is particularly useful for differentiating between urgent alerts, promotional messages, or user-specific notifications, enhancing engagement and recognition.\n\n"
					},
					"response": []
				},
				{
					"name": "Title & Message, Acknowledgement",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"user\": \"{{User Api Key}}\",\n  \"title\": \"A simple title\",\n  \"message\": \"A simple test message\",\n  \"requires_acknowledgement\": true,\n  \"acknowledgement\": {\n    \"requires_retry\": true,\n    \"max_retries\": \"10\",\n    \"interval\": \"15\"\n  }\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The Acknowledgements object in JustPush.io allows senders to track user interactions with a push message by requiring recipients to confirm receipt. When enabled, the message includes an acknowledgment request, prompting the user to take action, such as tapping a button to confirm they’ve seen it. The acknowledgment status is then recorded and can be retrieved via the API, providing insights into message engagement and ensuring critical notifications are noticed. This feature is particularly useful for high-priority messages, such as security alerts or urgent announcements, where confirmation of receipt is essential.\n\n## Be Aware\nThis request set an acknowledge with an interval of 60 seconds for 10 times. "
					},
					"response": []
				},
				{
					"name": "Title & Message, Button",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"user\": \"{{User Api Key}}\",\n  \"title\": \"A simple title\",\n  \"message\": \"A simple test message\",\n  \"buttons\": [\n    {\n      \"cta\": \"Button1\",\n      \"url\": \"https://www.action1.com\",\n      \"action_required\": false\n    }\n  ]\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The **Buttons** object in JustPush.io enables interactive push notifications by adding actionable buttons to a message. Each button can have a label and a specific action, such as opening a URL, triggering an in-app function, or acknowledging a message. Buttons enhance user engagement by allowing recipients to respond directly from the notification without opening the app. The message payload can include multiple buttons, each configured with an action type and optional metadata. This feature is ideal for prompts like confirming an appointment, opening a deep link, or executing quick actions, improving both user experience and response rates."
					},
					"response": []
				},
				{
					"name": "Title & Message, Button Groups",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\"user\":\"\",\"title\":\"A simple title\",\"message\":\"A simple test message\",\"button_groups\":[{\"name\":\"Group 1\",\"cta\":\"Group 1 Cta\",\"action_required\":true,\"buttons\":[{\"cta\":\"Button1\",\"url\":\"https://www.action1.com\",\"requires_action\":false},{\"cta\":\"Button2\",\"url\":\"https://www.action2.com\",\"requires_action\":true}]}]}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The Button Groups object in JustPush.io allows multiple predefined buttons to be grouped and reused across different messages. Instead of defining individual buttons for each notification, a button group simplifies the process by referencing a predefined set of actions. This ensures consistency in user interactions while reducing redundant configuration. When a button group is attached to a message, all associated buttons appear in the notification, enabling recipients to take immediate action. This feature is especially useful for common interactions such as approving or rejecting requests, quick replies, or navigating to specific app sections, improving efficiency and user engagement."
					},
					"response": []
				},
				{
					"name": "Title & Message, Expiry TTL",
					"protocolProfileBehavior": {
						"followRedirects": false,
						"followOriginalHttpMethod": false,
						"followAuthorizationHeader": false
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"user\": \"{{user_key}}\",\n    \"title\": \"A simple title\",\n    \"message\": \"A simple test message\",\n    \"expiry_ttl\": \"90\"\n}"
						},
						"url": {
							"raw": "https://api.justpush.io/messages",
							"protocol": "https",
							"host": [
								"api",
								"justpush",
								"io"
							],
							"path": [
								"messages"
							]
						},
						"description": "The Expiry (TTL) object in JustPush.io defines the time-to-live (TTL) for a push message, determining how long it should remain deliverable before expiring. If a device is offline or unreachable, the message will be stored and retried until the TTL duration is reached. Once expired, undelivered messages are discarded and will not be sent when the device reconnects. The TTL can be set in seconds, allowing control over message relevance and urgency. This feature is useful for time-sensitive notifications, such as OTPs, limited-time offers, or critical alerts, ensuring users receive messages only when they are still relevant.\n\n## Be Aware\nThis sample message has an expire of 90 seconds. "
					},
					"response": []
				}
			]
		}
	]
}