Webhooks

Update a webhook.

Replaces the URL, events and description; enabled is left as it is when omitted. Turning a webhook that failures switched off back on resets its failure count. The secret does not change.

put/api/Webhooks/{id}

Request

  • Base URL: https://api.3dprintlog.com
  • URL: https://api.3dprintlog.com/api/Webhooks/{id}
  • Auth: OAuth 2 (authorization code, authorization URL https://3dprintlog.auth0.com/authorize, token URL https://3dprintlog.auth0.com/oauth/token)

Path parameters

idstring uuid required

The webhook's id.

Request body

urlstring nullable

An absolute http or https URL on a public address.

descriptionstring nullable

A label, at most 100 characters.

eventsstring[] nullable

The events to send; omitted or empty means all of them.

enabledboolean nullable

Omitted means on when creating and unchanged when updating.

Response

The updated webhook.

idstring uuid
urlstring nullable
descriptionstring nullable
eventsstring[] nullable

print.started, print.finished and/or print.failed.

enabledboolean
consecutiveFailuresinteger

Deliveries in a row that failed after their retries.

lastDeliveryAtstring date-time nullable
lastStatusCodeinteger nullable

The HTTP status of the last delivery, or null when no response came back.

lastDeliveryResultstring nullable

success, http_error, timeout, connection_failed or blocked_address; null before the first delivery.

autoDisabledAtstring date-time nullable

When repeated failures turned it off; turning it back on clears this.

createdDatestring date-time
updatedDatestring date-time

Changes

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