Skip to content

IdempotencyKey

DocType for storing idempotency keys and their corresponding HTTP responses.

This table acts as a transactional cache for the Idempotency Middleware.
It is strictly a system-level table and is not exposed via the REST API or Desk UI.

Source: idempotency_key.py

Field Type Required Description Validators
key str The unique idempotency key provided by the client (usually a UUID). maxLen: 255
status_code int The HTTP status code of the original executed response. min: 100, max: 599
headers dict[str, str] A JSON representation of the HTTP headers from the original response. -
body bytes The raw binary body of the original HTTP response. -
Setting Value
Submittable False
Track Changes True

Controller hooks are implemented in *_controller.py files. Available lifecycle hooks:

  • validate() - Called before save, raise exceptions for validation errors
  • before_insert() - Called before inserting a new document
  • after_insert() - Called after successfully inserting
  • before_save() - Called before saving (insert or update)
  • after_save() - Called after saving
  • before_delete() - Called before deleting
  • after_delete() - Called after deleting