Octoprint

Receive a print event from the OctoPrint Webhooks plugin.

Called by the OctoPrint-Webhooks plugin, not by hand. Set it up as described at https://www.3dprintlog.com/docs/octoprint-webhook, authenticating with a personal API key.

The body is form data. deviceIdentifier must be the id of one of the caller's printers. A Print Started event creates a print in the Printing status. Print Done marks it Success, and Print Failed or Error mark it Failed.

post/api/Octoprint

Request

  • Base URL: https://api.3dprintlog.com
  • URL: https://api.3dprintlog.com/api/Octoprint
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://3dprintlog.auth0.com/authorize, token URL https://3dprintlog.auth0.com/oauth/token)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

namestring nullable

The file name. example.gcode marks the plugin's test webhook, which only checks the printer and logs nothing.

pathstring nullable
timenumber double nullable

Elapsed print time in seconds, on Print Done and Print Failed.

estimatedPrintTimenumber double nullable

OctoPrint's estimate from analysing the file, in seconds.

averagePrintTimenumber double nullable

The average of previous prints of this file, in seconds.

lastPrintTimenumber double nullable

The previous print of this file, in seconds.

hashstring nullable

SHA1 Hash of the file.

Response

Returned if the webhook was handled successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.