Dexie Cloud Web Hooks

Screenshot from https://manager.dexie.cloud

Adding and Editing Web Hooks

Properties of a Web Hook

Webhook Secret

Operations

1. Go to https://webhook.site and get your own unique URL to configure
2. Configure the URL as a new Web Hook. Keep the default filter to catch everything, or narrow down which tables, props and operations it will trigger on.
3. Save dialog
4. Save changes in the database edit page.
5. Use your application and trigger some change that syncs to Dexie Cloud and see watch the data flow to webhook.site
6. Implement your real web hook and logic and reconfigure the web hook to POST to it instead.

Web Hook Request

• HTTP Method: POST
• POST Body type:
  Copy

  export type WebHookPostBody = {
    changes: SyncChange[]
  }
  
  export type SyncChange =
    | UpsertSyncChange
    | UpdateSyncChange
    | DeleteSyncChange
  
  export interface UpsertSyncChange {
    type: 'upsert'
    realmId: string
    table: string
    key: string
    value: object
  }
  
  export interface UpdateSyncChange {
    type: 'update'
    realmId: string
    table: string
    key: string
    updates: { [keyPath: string]: any }
  }
  export interface DeleteSyncChange {
    type: 'delete'
    realmId: string
    table: string
    key: string
  }
  

  Example:
  Copy

  POST /api/mywebhook HTTP/1.1
  Host: yourapp.yourdomain.com
  Content-Type: application/json
  X-DexieCloud-Token: 3IFLLLQAHGIN32PCETPWVG2E5A
  
  {
    "changes": [
      {
        "type": "upsert",
        "realmId": "foo@bar.com",
        "table": "todoItems",
        "key": "tdi0Ph7h|YdzM77VzcMigVJrbRZcal",
        "value": {
          "todoListId": "tdl0PgXZPc1WWE1niV9fWmONB3Jcal",
          "realmId": "foo@bar.com",
          "title": "Hello",
          "id": "tdi0Ph7h|YdzM77VzcMigVJrbRZcal",
          "owner": "foo@bar.com",
        }
      }
    ]
  }
  
  POST /api/mywebhook HTTP/1.1
  Host: yourapp.yourdomain.com
  Content-Type: application/json
  X-DexieCloud-Token: 3IFLLLQAHGIN32PCETPWVG2E5A
  
  {
    "changes": [
      {
        "type": "update",
        "realmId": "foo@bar.com",
        "table": "todoItems",
        "key": "tdi0Ph7h|YdzM77VzcMigVJrbRZcal",
        "updates": {
          "done": true
        }
      }
    ]
  }
  
  POST /api/mywebhook HTTP/1.1
  Host: yourapp.yourdomain.com
  Content-Type: application/json
  X-DexieCloud-Token: 3IFLLLQAHGIN32PCETPWVG2E5A
  
  {
    "changes": [
      {
        "type": "delete",
        "realmId": "foo@bar.com",
        "table": "todoItems",
        "key": "tdi0Ph7h|YdzM77VzcMigVJrbRZcal"
      }
    ]
  }
  

Expected Response

HTTP/1.1 200 OK
Content-Length: 0

Updates Might Be Accumulated

Web hook for "new-user"

"new user" Request

• HTTP Method: POST
• POST Body type:
  Copy

  {
    "userId": string
    "email": string
  }
  

  Example:
  Copy

  POST /api/mywebhook2 HTTP/1.1
  Host: yourapp.yourdomain.com
  Content-Type: application/json
  Content-Length: 54
  
  {"userId":"foo@company.com","email":"bar@company.com"}
  

"new user" Response

• Status Code: 200
• Content-Type: application/json
• Reponse Body Type:
  Copy

  {
    "ok": boolean
    "action": 'reject' | 'eval' | 'prod'
    "userData"?: {
      "displayName"?: string
      "email"?: string
      [customProp: string]: any
    }
  }
  

  Example:
  Copy

  HTTP/1.1 200 Ok
  Content-Type: application/json
  Content-Length: 27
  
  {"ok":true,"action":"prod"}