You can extend the default PocketBase behavior with custom server-side code using the exposed JavaScript app event hooks.
Throwing an error or not calling e.next() inside a handler function stops the hook execution chain.
All hook handler functions share the same function(e){} signature and expect the
user to call e.next() if they want to proceed with the execution chain.
App hooks
onBootstrap hook is triggered when initializing the main
application resources (db, app settings, etc).
Note that attempting to access the database before the e.next() call will result in an error.
onBootstrap((e) => {
e.next()
// e.app
})
onSettingsReload hook is triggered every time when the $app.settings()
is being replaced with a new state.
Calling e.app.settings() after e.next() returns the new state.
onSettingsReload((e) => {
e.next()
// e.app.settings()
}) onBackupCreate is triggered on each $app.createBackup call.
onBackupCreate((e) => {
// e.app
// e.name - the name of the backup to create
// e.exclude - list of pb_data dir entries to exclude from the backup
}) onBackupRestore is triggered before app backup restore (aka. on $app.restoreBackup call).
onBackupRestore((e) => {
// e.app
// e.name - the name of the backup to restore
// e.exclude - list of dir entries to exclude from the backup
}) onTerminate hook is triggered when the app is in the process
of being terminated (ex. on SIGTERM signal).
Note that the app could be terminated abruptly without awaiting the hook completion.
onTerminate((e) => {
// e.app
// e.isRestart
}) Mailer hooks
onMailerSend hook is triggered every time when a new email is
being send using the $app.newMailClient() instance.
It allows intercepting the email message or to use a custom mailer client.
onMailerSend((e) => {
// e.app
// e.mailer
// e.message
// ex. change the mail subject
e.message.subject = "new subject"
e.next()
})
onMailerRecordAuthAlertSend hook is triggered when
sending a new device login auth alert email, allowing you to
intercept and customize the email message that is being sent.
onMailerRecordAuthAlertSend((e) => {
// e.app
// e.mailer
// e.message
// e.meta
// ex. change the mail subject
e.message.subject = "new subject"
e.next()
})
onMailerRecordPasswordResetSend hook is triggered when
sending a password reset email to an auth record, allowing
you to intercept and customize the email message that is being sent.
onMailerBeforeRecordResetPasswordSend((e) => {
// e.app
// e.mailer
// e.message
// e.meta
// ex. change the mail subject
e.message.subject = "new subject"
e.next()
})
onMailerRecordVerificationSend hook is triggered when
sending a verification email to an auth record, allowing
you to intercept and customize the email message that is being sent.
onMailerRecordVerificationSend((e) => {
// e.app
// e.mailer
// e.message
// e.meta
// ex. change the mail subject
e.message.subject = "new subject"
e.next()
})
onMailerRecordEmailChangeSend hook is triggered when sending a
confirmation new address email to an auth record, allowing
you to intercept and customize the email message that is being sent.
onMailerRecordEmailChangeSend((e) => {
// e.app
// e.mailer
// e.message
// e.meta
// ex. change the mail subject
e.message.subject = "new subject"
e.next()
})
onMailerRecordOTPSend hook is triggered when sending an OTP email
to an auth record, allowing you to intercept and customize the
email message that is being sent.
onMailerRecordOTPSend((e) => {
// e.app
// e.mailer
// e.message
// e.meta
// ex. change the mail subject
e.message.subject = "new subject"
e.next()
}) Realtime hooks
onRealtimeConnectRequest hook is triggered when establishing the SSE client connection.
Any execution after e.next() of a hook handler happens after the client disconnects.
onRealtimeConnectRequest((e) => {
// e.app
// e.client
// e.idleTimeout
// and all RequestEvent fields...
e.next()
}) onRealtimeSubscribeRequest hook is triggered when updating the
client subscriptions, allowing you to further validate and
modify the submitted change.
OnRealtimeSubscribeRequest((e) => {
// e.app
// e.client
// e.subscriptions
// and all RequestEvent fields...
e.next()
}) onRealtimeMessageSend hook is triggered when sending an SSE message to a client.
onRealtimeMessageSend((e) => {
// e.app
// e.client
// e.message
// and all original connect RequestEvent fields...
e.next()
}) Record model hooks
These are lower level Record model hooks and could be triggered from anywhere (custom console command, scheduled cron job, when calling e.save(record), etc.) and therefore they have no access to the request context!
If you want to intercept the builtin Web APIs and to access their request body, query parameters, headers or the request auth state, then please use the designated
Record *Request hooks
.
onRecordEnrich is triggered every time when a record is enriched
- as part of the builtin Record responses, during realtime message serialization, or when apis.enrichRecord is invoked.
It could be used for example to redact/hide or add computed temporary Record model props only for the specific request info.
onRecordEnrich((e) => {
// hide one or more fields
e.record.hide("role")
// add new custom field for registered users
if (e.requestInfo.auth?.collection()?.name == "users") {
e.record.withCustomData(true) // for security custom props require to be enabled explicitly
e.record.set("computedScore", e.record.get("score") * e.requestInfo.auth.get("base"))
}
e.next()
}, "posts")
onRecordValidate is a Record proxy model hook of onModelValidate.
onRecordValidate is called every time when a Record is being validated,
e.g. triggered by $app.validate() or $app.save().
// fires for every record
onRecordValidate((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordValidate((e) => {
// e.app
// e.record
e.next()
}, "users", "articles") Record model create hooks
onRecordCreate is a Record proxy model hook of onModelCreate.
onRecordCreate is triggered every time when a new Record is being created,
e.g. triggered by $app.save().
Operations BEFORE the e.next() execute before the Record validation
and the INSERT DB statement.
Operations AFTER the e.next() execute after the Record validation
and the INSERT DB statement.
onRecordAfterCreateSuccess or onRecordAfterCreateError hooks.
// fires for every record
onRecordCreate((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordCreate((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordCreateExecute is a Record proxy model hook of onModelCreateExecute.
onRecordCreateExecute is triggered after successful Record validation
and right before the model INSERT DB statement execution.
Usually it is triggered as part of the $app.save() in the following firing order:
onRecordCreate
->
onRecordValidate (skipped with $app.saveNoValidate())
->
onRecordCreateExecute
onRecordAfterCreateSuccess or onRecordAfterCreateError hooks.
// fires for every record
onRecordCreateExecute((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordCreateExecute((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordAfterCreateSuccess is a Record proxy model hook of onModelAfterCreateSuccess.
onRecordAfterCreateSuccess is triggered after each successful
Record DB create persistence.
// fires for every record
onRecordAfterCreateSuccess((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordAfterCreateSuccess((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordAfterCreateError is a Record proxy model hook of onModelAfterCreateError.
onRecordAfterCreateError is triggered after each failed
Record DB create persistence.
- immediate on
$app.save()failure - delayed on transaction rollback
// fires for every record
onRecordAfterCreateError((e) => {
// e.app
// e.record
// e.error
e.next()
})
// fires only for "users" and "articles" records
onRecordAfterCreateError((e) => {
// e.app
// e.record
// e.error
e.next()
}, "users", "articles") Record model update hooks
onRecordUpdate is a Record proxy model hook of onModelUpdate.
onRecordUpdate is triggered every time when a new Record is being updated,
e.g. triggered by $app.save().
Operations BEFORE the e.next() execute before the Record validation
and the UPDATE DB statement.
Operations AFTER the e.next() execute after the Record validation
and the UPDATE DB statement.
onRecordAfterUpdateSuccess or onRecordAfterUpdateError hooks.
// fires for every record
onRecordUpdate((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordUpdate((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordUpdateExecute is a Record proxy model hook of onModelUpdateExecute.
onRecordUpdateExecute is triggered after successful Record validation
and right before the model UPDATE DB statement execution.
Usually it is triggered as part of the $app.save() in the following firing order:
onRecordUpdate
->
onRecordValidate (skipped with $app.saveNoValidate())
->
onRecordUpdateExecute
onRecordAfterUpdateSuccess or onRecordAfterUpdateError hooks.
// fires for every record
onRecordUpdateExecute((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordUpdateExecute((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordAfterUpdateSuccess is a Record proxy model hook of onModelAfterUpdateSuccess.
onRecordAfterUpdateSuccess is triggered after each successful
Record DB update persistence.
// fires for every record
onRecordAfterUpdateSuccess((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordAfterUpdateSuccess((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordAfterUpdateError is a Record proxy model hook of onModelAfterUpdateError.
onRecordAfterUpdateError is triggered after each failed
Record DB update persistence.
- immediate on
$app.save()failure - delayed on transaction rollback
// fires for every record
onRecordAfterUpdateError((e) => {
// e.app
// e.record
// e.error
e.next()
})
// fires only for "users" and "articles" records
onRecordAfterUpdateError((e) => {
// e.app
// e.record
// e.error
e.next()
}, "users", "articles") Record model delete hooks
onRecordDelete is a Record proxy model hook of onModelDelete.
onRecordDelete is triggered every time when a new Record is being deleted,
e.g. triggered by $app.delete().
Operations BEFORE the e.next() execute before the Record validation
and the UPDATE DB statement.
Operations AFTER the e.next() execute after the Record validation
and the UPDATE DB statement.
onRecordAfterDeleteSuccess or onRecordAfterDeleteError hooks.
// fires for every record
onRecordDelete((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordDelete((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordDeleteExecute is a Record proxy model hook of onModelDeleteExecute.
onRecordDeleteExecute is triggered after the internal delete checks and
right before the Record the model DELETE DB statement execution.
Usually it is triggered as part of the $app.delete() in the following firing order:
onRecordDelete
->
internal delete checks
->
onRecordDeleteExecute
onRecordAfterDeleteSuccess or onRecordAfterDeleteError hooks.
// fires for every record
onRecordDeleteExecute((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordDeleteExecute((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordAfterDeleteSuccess is a Record proxy model hook of onModelAfterDeleteSuccess.
onRecordAfterDeleteSuccess is triggered after each successful
Record DB delete persistence.
// fires for every record
onRecordAfterDeleteSuccess((e) => {
// e.app
// e.record
e.next()
})
// fires only for "users" and "articles" records
onRecordAfterDeleteSuccess((e) => {
// e.app
// e.record
e.next()
}, "users", "articles")
onRecordAfterDeleteError is a Record proxy model hook of onModelAfterDeleteError.
onRecordAfterDeleteError is triggered after each failed
Record DB delete persistence.
- immediate on
$app.delete()failure - delayed on transaction rollback
// fires for every record
onRecordAfterDeleteError((e) => {
// e.app
// e.record
// e.error
e.next()
})
// fires only for "users" and "articles" records
onRecordAfterDeleteError((e) => {
// e.app
// e.record
// e.error
e.next()
}, "users", "articles") Collection model hooks
These are lower level Collection model hooks and could be triggered from anywhere (custom console command, scheduled cron job, when calling e.save(collection), etc.) and therefore they have no access to the request context!
If you want to intercept the builtin Web APIs and to access their request body, query parameters, headers or the request auth state, then please use the designated
Collection *Request hooks
.
onCollectionValidate is a Collection proxy model hook of onModelValidate.
onCollectionValidate is called every time when a Collection is being validated,
e.g. triggered by $app.validate() or $app.save().
// fires for every collection
onCollectionValidate((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionValidate((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles") Collection mode create hooks
onCollectionCreate is a Collection proxy model hook of onModelCreate.
onCollectionCreate is triggered every time when a new Collection is being created,
e.g. triggered by $app.save().
Operations BEFORE the e.next() execute before the Collection validation
and the INSERT DB statement.
Operations AFTER the e.next() execute after the Collection validation
and the INSERT DB statement.
onCollectionAfterCreateSuccess or onCollectionAfterCreateError hooks.
// fires for every collection
onCollectionCreate((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionCreate((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionCreateExecute is a Collection proxy model hook of onModelCreateExecute.
onCollectionCreateExecute is triggered after successful Collection validation
and right before the model INSERT DB statement execution.
Usually it is triggered as part of the $app.save() in the following firing order:
onCollectionCreate
->
onCollectionValidate (skipped with $app.saveNoValidate())
->
onCollectionCreateExecute
onCollectionAfterCreateSuccess or onCollectionAfterCreateError hooks.
// fires for every collection
onCollectionCreateExecute((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionCreateExecute((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionAfterCreateSuccess is a Collection proxy model hook of onModelAfterCreateSuccess.
onCollectionAfterCreateSuccess is triggered after each successful
Collection DB create persistence.
// fires for every collection
onCollectionAfterCreateSuccess((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionAfterCreateSuccess((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionAfterCreateError is a Collection proxy model hook of onModelAfterCreateError.
onCollectionAfterCreateError is triggered after each failed
Collection DB create persistence.
- immediate on
$app.save()failure - delayed on transaction rollback
// fires for every collection
onCollectionAfterCreateError((e) => {
// e.app
// e.collection
// e.error
e.next()
})
// fires only for "users" and "articles" collections
onCollectionAfterCreateError((e) => {
// e.app
// e.collection
// e.error
e.next()
}, "users", "articles") Collection mode update hooks
onCollectionUpdate is a Collection proxy model hook of onModelUpdate.
onCollectionUpdate is triggered every time when a new Collection is being updated,
e.g. triggered by $app.save().
Operations BEFORE the e.next() execute before the Collection validation
and the UPDATE DB statement.
Operations AFTER the e.next() execute after the Collection validation
and the UPDATE DB statement.
onCollectionAfterUpdateSuccess or onCollectionAfterUpdateError hooks.
// fires for every collection
onCollectionUpdate((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionUpdate((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionUpdateExecute is a Collection proxy model hook of onModelUpdateExecute.
onCollectionUpdateExecute is triggered after successful Collection validation
and right before the model UPDATE DB statement execution.
Usually it is triggered as part of the $app.save() in the following firing order:
onCollectionUpdate
->
onCollectionValidate (skipped with $app.saveNoValidate())
->
onCollectionUpdateExecute
onCollectionAfterUpdateSuccess or onCollectionAfterUpdateError hooks.
// fires for every collection
onCollectionUpdateExecute((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionUpdateExecute((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionAfterUpdateSuccess is a Collection proxy model hook of onModelAfterUpdateSuccess.
onCollectionAfterUpdateSuccess is triggered after each successful
Collection DB update persistence.
// fires for every collection
onCollectionAfterUpdateSuccess((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionAfterUpdateSuccess((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionAfterUpdateError is a Collection proxy model hook of onModelAfterUpdateError.
onCollectionAfterUpdateError is triggered after each failed
Collection DB update persistence.
- immediate on
$app.save()failure - delayed on transaction rollback
// fires for every collection
onCollectionAfterUpdateError((e) => {
// e.app
// e.collection
// e.error
e.next()
})
// fires only for "users" and "articles" collections
onCollectionAfterUpdateError((e) => {
// e.app
// e.collection
// e.error
e.next()
}, "users", "articles") Collection mode delete hooks
onCollectionDelete is a Collection proxy model hook of onModelDelete.
onCollectionDelete is triggered every time when a new Collection is being deleted,
e.g. triggered by $app.delete().
Operations BEFORE the e.next() execute before the Collection validation
and the UPDATE DB statement.
Operations AFTER the e.next() execute after the Collection validation
and the UPDATE DB statement.
onCollectionAfterDeleteSuccess or onCollectionAfterDeleteError hooks.
// fires for every collection
onCollectionDelete((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionDelete((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionDeleteExecute is a Collection proxy model hook of onModelDeleteExecute.
onCollectionDeleteExecute is triggered after the internal delete checks and
right before the Collection the model DELETE DB statement execution.
Usually it is triggered as part of the $app.delete() in the following firing order:
onCollectionDelete
->
internal delete checks
->
onCollectionDeleteExecute
onCollectionAfterDeleteSuccess or onCollectionAfterDeleteError hooks.
// fires for every collection
onCollectionDeleteExecute((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionDeleteExecute((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionAfterDeleteSuccess is a Collection proxy model hook of onModelAfterDeleteSuccess.
onCollectionAfterDeleteSuccess is triggered after each successful
Collection DB delete persistence.
// fires for every collection
onCollectionAfterDeleteSuccess((e) => {
// e.app
// e.collection
e.next()
})
// fires only for "users" and "articles" collections
onCollectionAfterDeleteSuccess((e) => {
// e.app
// e.collection
e.next()
}, "users", "articles")
onCollectionAfterDeleteError is a Collection proxy model hook of onModelAfterDeleteError.
onCollectionAfterDeleteError is triggered after each failed
Collection DB delete persistence.
- immediate on
$app.delete()failure - delayed on transaction rollback
// fires for every collection
onCollectionAfterDeleteError((e) => {
// e.app
// e.collection
// e.error
e.next()
})
// fires only for "users" and "articles" collections
onCollectionAfterDeleteError((e) => {
// e.app
// e.collection
// e.error
e.next()
}, "users", "articles") Request hooks
The request hooks are triggered only when the corresponding API request endpoint is accessed.
Record CRUD request hooks
onRecordsListRequest hook is triggered on each API Records list request.
Could be used to validate or modify the response before returning it to the client.
onRecordEnrich
hook because it is less error-prone and it is triggered
by all builtin Record responses (including when sending realtime Record events).
// fires for every collection
onRecordsListRequest((e) => {
// e.app
// e.collection
// e.records
// e.result
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "articles" collections
onRecordsListRequest((e) => {
// e.app
// e.collection
// e.records
// e.result
// and all RequestEvent fields...
e.next()
}, "users", "articles")
onRecordViewRequest hook is triggered on each API Record view request.
Could be used to validate or modify the response before returning it to the client.
onRecordEnrich
hook because it is less error-prone and it is triggered
by all builtin Record responses (including when sending realtime Record events).
// fires for every collection
onRecordViewRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "articles" collections
onRecordViewRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "articles")
onRecordCreateRequest hook is triggered on each API Record create request.
Could be used to additionally validate the request data or implement
completely different persistence behavior.
// fires for every collection
onRecordCreateRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "articles" collections
onRecordCreateRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "articles")
onRecordUpdateRequest hook is triggered on each API Record update request.
Could be used to additionally validate the request data or implement
completely different persistence behavior.
// fires for every collection
onRecordUpdateRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "articles" collections
onRecordUpdateRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "articles")
onRecordDeleteRequest hook is triggered on each API Record delete request.
Could be used to additionally validate the request data or implement
completely different delete behavior.
// fires for every collection
onRecordDeleteRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "articles" collections
onRecordDeleteRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "articles") Record auth request hooks
onRecordAuthRequest hook is triggered on each successful API
record authentication request (sign-in, token refresh, etc.).
Could be used to additionally validate or modify the authenticated
record data and token.
// fires for every auth collection
onRecordAuthRequest((e) => {
// e.app
// e.record
// e.token
// e.meta
// e.authMethod
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordAuthRequest((e) => {
// e.app
// e.record
// e.token
// e.meta
// e.authMethod
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordAuthRefreshRequest hook is triggered on each Record
auth refresh API request (right before generating a new auth token).
Could be used to additionally validate the request data or implement completely different auth refresh behavior.
// fires for every auth collection
onRecordAuthRefreshRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordAuthRefreshRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordAuthWithPasswordRequest hook is triggered on each
Record auth with password API request.
e.record could be nil if no matching identity is found, allowing
you to manually locate a different Record model (by reassigning e.record).
// fires for every auth collection
onRecordAuthWithPasswordRequest((e) => {
// e.app
// e.collection
// e.record (could be null)
// e.identity
// e.identityField
// e.password
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordAuthWithPasswordRequest((e) => {
// e.app
// e.collection
// e.record (could be null)
// e.identity
// e.identityField
// e.password
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordAuthWithOAuth2Request hook is triggered on each Record
OAuth2 sign-in/sign-up API request (after token exchange and before external provider linking).
If e.record is not set, then the OAuth2
request will try to create a new auth record.
To assign or link a different existing record model you can
change the e.record field.
// fires for every auth collection
onRecordAuthWithOAuth2Request((e) => {
// e.app
// e.collection
// e.providerName
// e.providerClient
// e.record (could be null)
// e.oauth2User
// e.createData
// e.isNewRecord
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordAuthWithOAuth2Request((e) => {
// e.app
// e.collection
// e.providerName
// e.providerClient
// e.record (could be null)
// e.oauth2User
// e.createData
// e.isNewRecord
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordRequestPasswordResetRequest hook is triggered on
each Record request password reset API request.
Could be used to additionally validate the request data or implement completely different password reset behavior.
// fires for every auth collection
onRecordRequestPasswordResetRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordRequestPasswordResetRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordConfirmPasswordResetRequest hook is triggered on
each Record confirm password reset API request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
// fires for every auth collection
onRecordConfirmPasswordResetRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordConfirmPasswordResetRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordRequestVerificationRequest hook is triggered on
each Record request verification API request.
Could be used to additionally validate the loaded request data or implement completely different verification behavior.
// fires for every auth collection
onRecordRequestVerificationRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordRequestVerificationRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordConfirmVerificationRequest hook is triggered on each
Record confirm verification API request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
// fires for every auth collection
onRecordConfirmVerificationRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordConfirmVerificationRequest((e) => {
// e.app
// e.collection
// e.record
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordRequestEmailChangeRequest hook is triggered on each
Record request email change API request.
Could be used to additionally validate the request data or implement completely different request email change behavior.
// fires for every auth collection
onRecordRequestEmailChangeRequest((e) => {
// e.app
// e.collection
// e.record
// e.newEmail
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordRequestEmailChangeRequest((e) => {
// e.app
// e.collection
// e.record
// e.newEmail
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordConfirmEmailChangeRequest hook is triggered on each
Record confirm email change API request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
// fires for every auth collection
onRecordConfirmEmailChangeRequest((e) => {
// e.app
// e.collection
// e.record
// e.newEmail
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordConfirmEmailChangeRequest((e) => {
// e.app
// e.collection
// e.record
// e.newEmail
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordRequestOTPRequest hook is triggered on each Record
request OTP API request.
e.record could be nil if no user with the requested email is found, allowing
you to manually create a new Record or locate a different Record model (by reassigning e.record).
// fires for every auth collection
onRecordRequestOTPRequest((e) => {
// e.app
// e.collection
// e.record (could be null)
// e.password
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordRequestOTPRequest((e) => {
// e.app
// e.collection
// e.record (could be null)
// e.password
// and all RequestEvent fields...
e.next()
}, "users", "managers")
onRecordAuthWithOTPRequest hook is triggered on each Record
auth with OTP API request.
// fires for every auth collection
onRecordAuthWithOTPRequest((e) => {
// e.app
// e.collection
// e.record
// e.otp
// and all RequestEvent fields...
e.next()
})
// fires only for "users" and "managers" auth collections
onRecordAuthWithOTPRequest((e) => {
// e.app
// e.collection
// e.record
// e.otp
// and all RequestEvent fields...
e.next()
}, "users", "managers") Batch request hooks
onBatchRequest hook is triggered on each API batch request.
Could be used to additionally validate or modify the submitted batch requests.
This hook will also fire the corresponding onRecordCreateRequest, onRecordUpdateRequest, onRecordDeleteRequest hooks, where e.app is the batch transactional app.
onBatchRequest((e) => {
// e.app
// e.batch
// and all RequestEvent fields...
e.next()
}) File request hooks
onFileDownloadRequest hook is triggered before each API File download request.
Could be used to validate or modify the file response before returning it to the client.
onFileDownloadRequest((e) => {
// e.app
// e.collection
// e.record
// e.fileField
// e.servedPath
// e.servedName
// and all RequestEvent fields...
e.next()
})
onFileTokenRequest hook is triggered on each auth file token API request.
// fires for every auth model
onFileTokenRequest((e) => {
// e.app
// e.record
// e.token
// and all RequestEvent fields...
e.next();
})
// fires only for "users"
onFileTokenRequest((e) => {
// e.app
// e.record
// e.token
// and all RequestEvent fields...
e.next();
}, "users") Collection request hooks
onCollectionsListRequest hook is triggered on each API Collections list request.
Could be used to validate or modify the response before returning it to the client.
onCollectionsListRequest((e) => {
// e.app
// e.collections
// e.result
// and all RequestEvent fields...
e.next()
}) onCollectionViewRequest hook is triggered on each API Collection view request.
Could be used to validate or modify the response before returning it to the client.
onCollectionViewRequest((e) => {
// e.app
// e.collection
// and all RequestEvent fields...
e.next()
}) onCollectionCreateRequest hook is triggered on each API Collection create request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
onCollectionCreateRequest((e) => {
// e.app
// e.collection
// and all RequestEvent fields...
e.next()
}) onCollectionUpdateRequest hook is triggered on each API Collection update request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
onCollectionUpdateRequest((e) => {
// e.app
// e.collection
// and all RequestEvent fields...
e.next()
}) onCollectionDeleteRequest hook is triggered on each API Collection delete request.
Could be used to additionally validate the request data or implement completely different delete behavior.
onCollectionDeleteRequest((e) => {
// e.app
// e.collection
// and all RequestEvent fields...
e.next()
}) onCollectionsImportRequest hook is triggered on each API
collections import request.
Could be used to additionally validate the imported collections or to implement completely different import behavior.
onCollectionsImportRequest((e) => {
// e.app
// e.collectionsData
// e.deleteMissing
e.next()
}) Settings request hooks
onSettingsListRequest hook is triggered on each API Settings list request.
Could be used to validate or modify the response before returning it to the client.
onSettingsListRequest((e) => {
// e.app
// e.settings
// and all RequestEvent fields...
e.next()
}) onSettingsUpdateRequest hook is triggered on each API Settings update request.
Could be used to additionally validate the request data or implement completely different persistence behavior.
onSettingsUpdateRequest((e) => {
// e.app
// e.oldSettings
// e.newSettings
// and all RequestEvent fields...
e.next()
}) Base model hooks
The Model hooks are fired for all PocketBase structs that implements the Model DB interface - Record, Collection, Log, etc.
For convenience, if you want to listen to only the Record or Collection DB model
events without doing manual type assertion, you can use the
onRecord*
and
onCollection*
proxy hooks above.
onModelValidate is called every time when a Model is being validated,
e.g. triggered by $app.validate() or $app.save().
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelValidate((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelValidate((e) => {
// e.app
// e.model
e.next()
}, "users", "articles") Base model create hooks
onModelCreate is triggered every time when a new Model is being created,
e.g. triggered by $app.save().
Operations BEFORE the e.next() execute before the Model validation
and the INSERT DB statement.
Operations AFTER the e.next() execute after the Model validation
and the INSERT DB statement.
onModelAfterCreateSuccess or onModelAfterCreateError hooks.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelCreate((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelCreate((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelCreateExecute is triggered after successful Model validation
and right before the model INSERT DB statement execution.
Usually it is triggered as part of the $app.save() in the following firing order:
onModelCreate
->
onModelValidate (skipped with $app.saveNoValidate())
->
onModelCreateExecute
onModelAfterCreateSuccess or onModelAfterCreateError hooks.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelCreateExecute((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelCreateExecute((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelAfterCreateSuccess is triggered after each successful
Model DB create persistence.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelAfterCreateSuccess((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelAfterCreateSuccess((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelAfterCreateError is triggered after each failed
Model DB create persistence.
- immediate on
$app.save()failure - delayed on transaction rollback
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelAfterCreateError((e) => {
// e.app
// e.model
// e.error
e.next()
})
// fires only for "users" and "articles" models
onModelAfterCreateError((e) => {
// e.app
// e.model
// e.error
e.next()
}, "users", "articles") Base model update hooks
onModelUpdate is triggered every time when a new Model is being updated,
e.g. triggered by $app.save().
Operations BEFORE the e.next() execute before the Model validation
and the UPDATE DB statement.
Operations AFTER the e.next() execute after the Model validation
and the UPDATE DB statement.
onModelAfterUpdateSuccess or onModelAfterUpdateError hooks.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelUpdate((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelUpdate((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelUpdateExecute is triggered after successful Model validation
and right before the model UPDATE DB statement execution.
Usually it is triggered as part of the $app.save() in the following firing order:
onModelUpdate
->
onModelValidate (skipped with $app.saveNoValidate())
->
onModelUpdateExecute
onModelAfterUpdateSuccess or onModelAfterUpdateError hooks.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelUpdateExecute((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelUpdateExecute((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelAfterUpdateSuccess is triggered after each successful
Model DB update persistence.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelAfterUpdateSuccess((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelAfterUpdateSuccess((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelAfterUpdateError is triggered after each failed
Model DB update persistence.
- immediate on
$app.save()failure - delayed on transaction rollback
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelAfterUpdateError((e) => {
// e.app
// e.model
// e.error
e.next()
})
// fires only for "users" and "articles" models
onModelAfterUpdateError((e) => {
// e.app
// e.model
// e.error
e.next()
}, "users", "articles") Base model delete hooks
onModelDelete is triggered every time when a new Model is being deleted,
e.g. triggered by $app.delete().
Operations BEFORE the e.next() execute before the Model validation
and the UPDATE DB statement.
Operations AFTER the e.next() execute after the Model validation
and the UPDATE DB statement.
onModelAfterDeleteSuccess or onModelAfterDeleteError hooks.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelDelete((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelDelete((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelDeleteExecute is triggered after the internal delete checks and
right before the Model the model DELETE DB statement execution.
Usually it is triggered as part of the $app.delete() in the following firing order:
onModelDelete
->
internal delete checks
->
onModelDeleteExecute
onModelAfterDeleteSuccess or onModelAfterDeleteError hooks.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelDeleteExecute((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelDeleteExecute((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelAfterDeleteSuccess is triggered after each successful
Model DB delete persistence.
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelAfterDeleteSuccess((e) => {
// e.app
// e.model
e.next()
})
// fires only for "users" and "articles" models
onModelAfterDeleteSuccess((e) => {
// e.app
// e.model
e.next()
}, "users", "articles")
onModelAfterDeleteError is triggered after each failed
Model DB delete persistence.
- immediate on
$app.delete()failure - delayed on transaction rollback
For convenience, if you want to listen to only the Record or Collection models
events without doing manual type assertion, you can use the equivalent onRecord* and onCollection* proxy hooks.
// fires for every model
onModelAfterDeleteError((e) => {
// e.app
// e.model
// e.error
e.next()
})
// fires only for "users" and "articles" models
onModelAfterDeleteError((e) => {
// e.app
// e.model
// e.error
e.next()
}, "users", "articles")