Appwrite Website Documentation

Appwrite Messaging is a service designed to facilitate communication with users through multiple channels. It can be used for marketing, real-time updates, alerts, and security-related workflows like custom authentication flows.

Supported communication channels include:

• Push Notifications
• Emails
• SMS text messages

The Organization service is used to manage resources that exist at the organization level rather than the individual project level. This includes managing projects, memberships, API keys, and installations.

Key capabilities include:

• Project Management: Create and manage the organization's projects.
• Membership Management: Invite and manage members within the organization.
• Organization-scoped API Keys: Issue API keys that allow automation to span across multiple projects.
• Installations: Connect the organization to external providers.

The VCS service in Appwrite allows you to interact with Version Control System providers (such as Git or GitHub) to manage code repositories.

Key capabilities include:

• App Management: Installing the VCS app within Appwrite.
• Repository Management: Creating, listing, and deleting repositories.
• Code Operations: Performing clone, push, and pull operations on your repositories.
• Function Integration: Linking an existing code repository to an Appwrite Function. When a repository is linked, Appwrite automatically triggers a new deployment whenever changes are pushed to that repository.

This repository contains the source code for the main Appwrite website, which includes the homepage, documentation, and the upcoming blog. The project is built using the following frameworks:

• Svelte
• SvelteKit

The Webhooks service enables real-time integration between Appwrite and external systems. You can configure webhooks to notify an HTTP endpoint that you control whenever specific events occur within your Appwrite project.

Key capabilities include:

• Event Subscription: Choose specific project events that trigger a webhook delivery.
• Lifecycle Management: Create, update, and delete webhook configurations.
• Security: Rotate secret keys used to sign deliveries, allowing your endpoint to verify that incoming requests are authentic and originate from Appwrite.

The TablesDB service provides a way to manage structured data using a hierarchical organization of databases and tables.

Key features include:

• Structured Data: All data is represented as structured JSON rows.
• Hierarchical Organization: A single TablesDB service can contain multiple databases, and each database can contain multiple tables.
• Schema Enforcement: Tables consist of groups of similarly structured rows. The structure is defined by table columns, which ensure that user-submitted data is validated and stored correctly.
• Granular Access Control: TablesDB integrates with Appwrite's permissions architecture, allowing you to assign read or write access at both the table and row levels. Access can be granted to specific users, teams, user roles, or the public (any).

The Teams service enables you to group users within your project to manage shared access to resources. You can use teams to share read and write permissions for specific resources, such as database rows or storage files, across a group of users.

Key Ownership Rules:

• Team Creation: The user who creates a team is automatically designated as the team owner.
• Delegation: Team owners have the authority to delegate the ownership role by inviting new members to the team.
• Invitations: Only users with the team owner role can invite new users to join a team.

The Avatars service provides tools for managing app imagery, icons, and avatars. It allows you to fetch various assets including:

• Country flags
• Browser icons
• Payment method logos
• Remote website favicons
• QR codes
• Remote image manipulation (via URL manipulation)

All endpoints in this service support image transformations such as resizing, cropping, and adjusting output quality to optimize performance and visibility within your application.

The Users service provides tools to manage project users. It allows you to perform the following tasks:

• Search and discovery: Find users within your project.
• User management: Block users or view their personal information and preferences.
• Activity monitoring: View a user's current active sessions and their latest activity logs.
• Profile management: Edit user preferences and personal information.

The Functions service enables you to execute custom backend code in response to specific triggers. Functions are stored securely on your Appwrite instance and run in isolated environments to ensure security and stability.

Functions can be triggered in two primary ways:

1. Appwrite System Events: Automatically run code in response to events occurring within your Appwrite project (e.g., database changes, user authentication events).
2. Predefined Schedules: Execute code at specific intervals or times using a scheduler.

For a step-by-step implementation guide, refer to the Cloud Functions tutorial.