Webhook JSON Payload Format¶

The HTTP POST request includes a JSON body with these properties:

• PrinterId
  • (string) A stable unique ID for your printer. This ID will not change as long as your printer remains attached to your account.
• SecretKey
  • (string) If you set a secret key, it will be included here.
• PrintId
  • (string) A unique string for each print. This string is created when a print starts and remains until the print is complete or stopped, making it useful for tracking which notifications are associated with which print jobs.
• EventType
  • (int, enum) This enum maps to the notification type. The enum is defined here.
• PrinterName
  • (string) The name you assigned your printer. This name will change if the printer is renamed on OctoEverywhere.
• SnapshotUrl
  • (string, optional) If a snapshot can be captured, this will be a URL where the image can be viewed or downloaded. This image URL will remain valid for about 7 days.
• QuickViewUrl
  • (string) A URL to OctoEverywhere's Quick View, which provides a secure, internet-based way to quickly view the full printer state, pause prints, and cancel prints.
• FileName
  • (string, optional) The file name in OctoPrint for the current file being printed.
• DurationSec
  • (int, optional) The duration of the print since it started, in seconds.
• Progress
  • (int, optional) The current print progress as a percentage, where 0 is 0% and 100 is 100%.
• TimeRemainingSec
  • (int, optional) The estimated remaining print time reported by OctoPrint, in seconds.
• ZOffsetMM
  • (int, optional) The current Z-axis offset in millimeters.
• Error
  • (string, optional) For event types that indicate an error, this string may contain an error message from OctoPrint describing the issue.

An example JSON body might look like this:

{
    "PrinterId": "Id",
    "SecretKey": "Key",
    "PrintId": "Id",
    "EventType": 1,
    "PrinterName": "Ender3",
    "SnapshotUrl": "https://...",
    "QuickViewUrl": "https://...",
    "FileName": "MyCoolPrint",
    "DurationSec": 50,
    "Progress": 21,
    "TimeRemainingSec": 605,
    "ZOffsetMM": 300,
}