Webhooks

Create a webhook.

Returns the signing secret once; it cannot be shown again (rotate it for a new one). The URL must be http or https on a public address: private, loopback, link-local and reserved addresses are refused with code: "blocked_webhook_address". Events default to all three. The Free plan includes one webhook and Pro ten; one more returns 403 with code: "webhook_limit" and the limit.

post/api/Webhooks

Request

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

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 new webhook, with its secret.

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
secretstring nullable

Changes

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