​

Hooks

​

How Hooks Work

def main():
    event = req.payload.get("event")       # e.g. "pre_save", "post_login"
    document = req.payload.get("document") # the document data (collection hooks)
    user = req.payload.get("user")         # the user data (auth hooks)
    return {"ok": True}

​

Two Types of Hooks

​

Collection Hooks

​

Auth Hooks

​

Blocking vs Background Hooks

​

Background (fire-and-forget)

​

Blocking (pre_login, pre_register)

# Block the operation
return {"block": True, "reason": "Account suspended."}

# Allow the operation
return {"block": False}
# or just return nothing — silence means allow

​

Setting Up Hooks

​

Collection Hooks

1. Go to Dashboard → Your Project → Collections
2. Click the collection you want to attach a hook to
3. Open the Settings tab
4. Click Add Hook
5. Choose an event and select your cloud function
6. Save

​

Auth Hooks

1. Go to Dashboard → Your Project → App Users
2. Click the Auth Hooks tab
3. Click Add Hook
4. Choose an event and select your cloud function
5. Save

​

Next Steps

• Collection Hooks — Full reference for pre_save, post_save, pre_delete, post_delete
• Auth Hooks — Full reference for all auth lifecycle events
• Hook Examples — Copy-paste recipes for common use cases