Webhook

The Webhook function is provided as a means to report statuses to external applications.

The following status types are reported.

Event type	Sub-type	Explanation
`test`	`sub_test`	A test event triggered from the dashboard
`connection`	`added_new`	Addition of a new device to a device group
	`added_renew`	Re-registration of a device to a device group
	`deleted_temporary`	Deletion of a device from a device group (logical deletion)
	`deleted_complete`	Deletion of a device from a device group (physical deletion)
`status`	`online`	Change of device status (online)
`status`	`offline`	Change of device status (offline)
`job`	`received`	Completion of printing job requesting to the server
	`requested`	Completion of printing job requesting from the server to the device
	`completed`	Completion of printing job (normal end)
	`failed`	Completion of printing job (abnormal end)
`peripheral`	`barcode_scan`	Barcode scanning

In order to utilize this function, permit access from the following network IP address of the report origin.

[US region]

Network IP address: 52.229.30.53

[EU region]

Network IP address: 20.68.6.254

Test Event

A Test Event can only be triggered by clicking the Webhook notification test button.
A test event can be generated even if reporting is not effective.

Header

{		
	"Content-Type": "application/json"	
	"User-Agent": "StarIO_Online/1.0"	
}

Body

{
	"EventType": "test",
	"SubType": "sub_test",
	"DeviceGroup": {	
		"Path": "dgrp",
		"Name": "Demo Group"
	},
	"Device": {
		"Mac": "000000000000",
		"Name": "Test Name",
		"AppID": "00000000"
	}
}

Connection Event

Connection Event is issued each time the connection status of an in-group device is changed.
This event can be used to report that a new device was added to a device group.

SubType	Explanation
`added_new`	Addition of a new device to a device group
`added_renew`	Re-registration of a device to a device group
`deleted_temporary`	Deletion of a device from a device group (logical deletion)
`deleted_complete`	Deletion of a device from a device group (physical deletion)

Header

{
	"Content-Type": "application/json"
	"User-Agent": "StarIO_Online/1.0"
}

Body

{
	"EventType": "connection",
	"SubType": "added_new",
	"DeviceGroup": {	
		"Path": "dgrp",
		"Name": "Demo Group"
	},
	"Device": {
		"Mac": "001C62030846",
		"Name": "Demonstration mC-Print2",
		"AppID": "e9442f5f"
	},
	"EventData": {
		"Status": {
			"Online": true,
			"CoverOpen": false,
			"CompulsionSwitch": false,
			"OverTemperature": false,
			"Recoverable": true,
			"CutterError": false,
			"MechanicalError": false,
			"ReceiveBufferOverflow": false,
			"BlackMarkError": false,
			"PresenterPaperJam": false,
			"VoltageError": false,
			"PaperEmpty": false,
			"PaperLow": false
		}
	}
}

Status Event

Status Event is issued each time the status reported by a device is changed.
For logging convenience, the SubType is set as “online” or “offline”, which represents the overall operational status of the device. The field structure remains consistent in both cases.

SubType	Explanation
`online`	Change of device status (online)
`offline`	Change of device status (offline)

Header

{
	"Content-Type": "application/json"
	"User-Agent": "StarIO_Online/1.0"
}

Body

{
	"EventType": "status",
	"SubType": "offline",
	"DeviceGroup": {	
		"Path": "dgrp",
		"Name": "Demo Group"
	},
	"Device": {
		"Mac": "001C62030846",
		"Name": "Demonstration mC-Print2",
		"AppID": "e9442f5f"
	},
	"EventData": {
		"Status": {
			"Online": false,
			"CoverOpen": true,
			"CompulsionSwitch": false,
			"OverTemperature": false,
			"Recoverable": true,
			"CutterError": false,
			"MechanicalError": false,
			"ReceiveBufferOverflow": false,
			"BlackMarkError": false,
			"PresenterPaperJam": false,
			"VoltageError": false,
			"PaperEmpty": true,
			"PaperLow": false
		},
		"PreviousStatus": {
			"Online": true,
			"CoverOpen": false,
			"CompulsionSwitch": false,
			"OverTemperature": false,
			"Recoverable": true,
			"CutterError": false,
			"MechanicalError": false,
			"ReceiveBufferOverflow": false,
			"BlackMarkError": false,
			"PresenterPaperJam": false,
			"VoltageError": false,
			"PaperEmpty": false,
			"PaperLow": false
		}
	}
}

Job Event

Job Event is related to printing job activities and can be used to receive a report when a device starts processing a job from its print queue, when printing is completed, or when an error has occurred.

SubType	Explanation
`received`	Completion of printing job requesting to the server
`requested`	Completion of printing job requesting from the server to the device
`completed`	Completion of printing job (normal end)
`failed`	Completion of printing job (abnormal end)

Printing start: requested

Header

{
	"Content-Type": "application/json"
	"User-Agent": "StarIO_Online/1.0"
}

Body

{
	"EventType": "job",	
	"SubType": "requested",	
	"DeviceGroup": {	
		"Path": "dgrp",
		"Name": "Demo Group"
	},
	"Device": {	
		"Mac": "001C62030846",
		"Name": "Demonstration mC-Print2",
		"AppID": "e9442f5f"
	},
	"EventData": {	
		"JobName": "Welcome",
		"RequestedMediaType": "application/vnd.star.starprnt"
	}
}

JobName

Job name (if assigned). This can be specified when a job is sent to the service.

RequestedMediaType

The format requested by a CloudPRNT-compatible device for the printing job.

Print completion: completed

Header

{
	"Content-Type": "application/json"
	"User-Agent": "StarIO_Online/1.0"
}

Body

{
	"EventType": "job",
	"SubType": "completed",
	"DeviceGroup": {
		"Path": "dgrp",
		"Name": "Demo Group"
	},
	"Device": {
		"Mac": "001C62030846",
		"Name": "Demonstration mC-Print2",
		"AppID": "e9442f5f"
	},
	"EventData": {
		"Code": 200,
		"CodeDescription": "OK",
		"JobName": "Welcome"
	}
}

Code

CloudPRNT job completion code. Refer to here for the details of CloudPRNT specifications status codes.

CodeDescription

The description of the meaning of codes useful for logging.

JobName

Job name (if assigned). This can be specified when a job is sent to the service.

Print completion: failed

Header

{
	"Content-Type": "application/json"
	"User-Agent": "StarIO_Online/1.0"
}

Body

{
	"EventType": "job",	
	"SubType": "failed",	
	"DeviceGroup": {	
		"Path": "dgrp",
		"Name": "Demo Group"
	},
	"Device": {	
		"Mac": "001C62030846",
		"Name": "Demonstration mC-Print2",
		"AppID": "e9442f5f"
	},
	"EventData": {	
		"Code": 520,
		"CodeDescription": "Timeout",
		"JobName": "Welcome"
	}
}

Code

CloudPRNT job completion code. Refer to here for the details of CloudPRNT specifications status codes.

CodeDescription

The description of the meaning of codes useful for logging.

JobName

Job name (if assigned). This can be specified when a job is sent to the service.

Peripheral Event

Peripheral Event is used to report activities related to POS peripherals (USK barcode scanners, etc.) other than printers connected to ColudPRNT devices.

Barcode scanning: barcode_scan

Header

{
	"Content-Type": "application/json"
	"User-Agent": "StarIO_Online/1.0"
}

Body

{
	"EventType": "peripheral",
	"SubType": "barcode_scan",
	"DeviceGroup": {
		"Path": "dgrp",
		"Name": "Demo Group"
	},
	"Device": {
		"Mac": "001C62030846",
		"Name": "Demonstration mC-Print2",
		"AppID": "e9442f5f"
	},
	"EventData": {
		"Scans": [
			{
				"BCR": "MainBCR",
				"Ascii": "3700597302378",
				"Base64": "MzcwMDU5NzMwMjM3OA=="
			}
		]
	}
}

Scans

The sequence of scanned bar-codes.
Multiple scans may be reported as a single event if multiple scans were performed within a very short time.

BCR

The name of a barcode reader which executed scans.
This is always “MainBCR” for a CloudPRNT-compatible device.

Ascii

ASCII-encoded scan data.
Non-ASCII characters in the source barcode are not reported in this field.

Base64

base64-encoded scan data.
This is useful when a barcode including non-ASCII characters must be scanned.

Note:

Barcode scanning is reported by a device only if a barcode reader is requested by the CloudPRNT service.
This can be enabled for all devices in the device group by changing the device group settings.
By default, a barcode reader is not required by a new device group in order to avoid contention with an existing POS application.