Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.valued.app/llms.txt

Use this file to discover all available pages before exploring further.

The sync event category is for updating user and customer profile information and, associated customers and users with memberships on Valued. To guarantee your data is always up-to-date, include sync events in your backend application, running one-off or periodic bulk sync imports. To sync a user or a customer is required, but not both. If both are included, Valued ignores this event. A membership event should only include the membership details. All event attributes included in the user or customer structure will update all information we have on the user or customer.

​
Event format

Sync events are identified with category=sync.

​
Customer sync

{
    "category": "sync",
    "customer": {
        "id": "123",
        "name": "Mystery Shack",
        "location": {
            "country": "US",
            "state": "OR"
        }
    }
}

​
User sync

{
    "category": "sync",
    "user": {
        "id": "456",
        "name": "Stanley Pines",
        "email": "stanley.pines@mysteryshack.biz",
        "location": {
            "country": "US",
            "state": "OR"
        },
        "hobbies": [
            "grifting",
            "gold chains",
        ]
    }
}

​
Single Membership Sync

{
  "category": "sync",
  "membership": {
    "customer_id": "456",
    "user_id": "123",
    "role": "admin",
    "joined_at": 1685702164,
    "left_at": null
  }
}

​
Multiple Membership Customer Sync

{
  "category": "sync",
  "customer": {
    "id": "123",
    "memberships": [
      {
        "user_id": "457",
        "role": "viewer",
        "joined_at": 1685702164,
        "left_at": null
      },
      {
        "user_id": "456",
        "role": "admin",
        "joined_at": 1685702164,
        "left_at": null
      }
    ]
  }
}