You are viewing Skygear v1 Documentation.Switch to Skygear v0 Documentation

Quick Start

Quick Start Guide

Adding Skygear to your iOS, Android and web apps

Integrating frameworks

Integrating Webpack, Ionic and Angular

User Authentication

User Authentication Basics

User Log-in/Log-out, user access tokens, email and password managements

Social Login

Third-party login, e.g. Facebook, Google

Authenticate with a custom auth system

Integrate authentication server to Skygear using JWT

User Profile Best Practices

Saving and retrieving custom profile attributes

Disabling User Accounts

Learn how to disable a user account

Skygear Cloud Database

Cloud Database Basics

Storing data in the database using Records, with guides to basic record CRUD (create, read, update, delete)


From the simplest queries to more complex ones such as AND/OR conditions and pagination

Data Types

A guide to the supported data types: numbers, strings, foreign keys, locations, file uploads and more

Access Control Overview

Setting up restriction to certain database table or individual record is easy

Record-based ACL

Setting up access control on record level

Field-based ACL

Setting up access control on record field level

Offline Storage

Creating cached queries to save query results locally

Query Subscriptions

Subscribing to database data changes from the client

Skygear Chat

Quick Start for Chat

Adding Skygea Chat to your iOS, Android and web apps

Skygear Chat Basics

Creating chatrooms, sending and receiving messages with Chat APIs

Skygear Chat Data Models

Data models of Skygear Chat

Chat Event Hooks

Running codes upon chat event such as message sent

Skygear Chat UI Kit

UIKit of Skygear Chat

Skygear PubSub

PubSub Basics

Adding the publish-subscribe functioality to your app with Skygear

Push Notifications

Setting up Push Notification

Setting Push Notification with FCM or APN

Push Notification Basics

Sending push notifications with Skygear

Cloud Functions

Introduction to Cloud Functions

The first step to using the Skygear cloud functions to have your codes running on Skygear server

Trigger by Database Event

Running codes upon database events such as creating, updating or deleting records

Trigger by Schedule

Executing your server codes at specified time or intervals

Trigger by Client SDK

Lambda functions can be called from the SDKs to execute your custom codes on Skygear server

Trigger by HTTP Endpoint

Creating your own HTTP endpoint so that external applications can send GET/POST and other requests to your app

Trigger by Restful HTTP Endpoint

Creating your own set of restful HTTP endpoint easily through cloud functions

Trigger by Chat Events

Running codes upon chat event such as message sent

Serving Static Assets

Methods to make your static assets such as images accessible with a URL

APIs in Cloud Functions

Calling Skygear API, using database connections, pubsub, push notifications, and using the master key to impersonate user for the admin

Authenticating Users

Getting the authenticated user ID from the cloud functions, and resetting the password of a user

Error Handling

Error handling in cloud functions


Deploy Skygear Local Server

Reference for deploy Skygear server

Skygear Database Schema

More details about database record tables, reserved columns, schema migration and reserved tables

Custom Authentication Provider

User authentication with third-party service

Error Handling in the SDKs

Handle error with error codes in SDK when operations fail

User Relations

Creating Friends/Followers relationships