OutboxEntry

An entry in the transactional outbox.

Stores pending operations to external systems atomically in SQL,
processed by the background outbox relay job.

Source: outbox.py

Fields

Field	Type	Required	Description	Validators
target	str		-	-
payload	None		-	-
status	OutboxStatus		-	-
processed_at	None		-	-
error	None		-	-
retry_count	int		-	-
reference_doctype	None		-	-
reference_id	None		-	-
next_attempt_at	None		-	-
locked_by	None		-	-
locked_at	None		-	-

Permissions

Role	Create	Delete	Read	Write
All	✓	✓	✓	✓

Configuration

Setting	Value
Submittable	False
Track Changes	True

Controller

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