API Endpoint Reference / Webhooks

Update a webhook endpoint

PATCH https://api.printhiv3d.com/v1/webhooks/{id}

Operation ID updateWebhook. Requires the webhooks:write API key scope.

Changes the name, URL, event types or enabled flag. rotate_secret: true replaces the signing secret, returns the new one once, and ends the old one for later attempts. Setting enabled: true resets the failure count.

Parameters

NameInTypeRequiredDescription
idpathuuidYes

Request body

Content type application/json.

FieldTypeRequiredDescription
namestringNo
urluriNoAn HTTPS URL with a public DNS hostname. IP literals, credentials and fragments are refused.
event_types("model.created" | "model_file.uploaded" | "job.created" | "job.assigned" | "job.started" | "job.paused" | "job.resumed" | "job.recovered" | "job.completed" | "job.failed" | "job.cancelled" | "printer.ready" | "printer.online" | "printer.offline")[]No
enabledbooleanNo
rotate_secretbooleanNo

Responses

StatusDescription
200Default Response
400Default Response
401Default Response
403Default Response
404Default Response
503Default Response

200 response fields

FieldTypeRequiredDescription
iduuidYes
organization_iduuidYes
namestringYes
urlstringYes
event_typesstring[]YesThe types the endpoint subscribes to. Print Hive adds types, so a reader ignores a name it does not know.
enabledbooleanYes
consecutive_failuresintegerYes
created_atstringYes
updated_atstringYes
signing_secretstringNoThe HMAC-SHA256 secret that signs every delivery. Returned only when the endpoint is created and when rotate_secret is true. Store it now; later reads never return it.

400 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

401 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

403 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

404 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

503 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

Example 200 response

{
  "id": "2a6f0d8e-5c3b-4d19-b7a4-9e1c8f5d3a60",
  "organization_id": "3b9e4d71-0c2f-4a58-8e6d-91f2a7c4b605",
  "name": "Fulfilment service",
  "url": "https://hooks.example.com/printhive",
  "event_types": [
    "job.started",
    "job.completed",
    "job.failed",
    "printer.offline"
  ],
  "enabled": false,
  "consecutive_failures": 0,
  "created_at": "2026-11-04T18:00:00.000Z",
  "updated_at": "2026-11-04T18:00:00.000Z"
}