The Experience Object

An experience is what the user has access to upon getting a Membership. It is super flexible and more are being added constantly. Each of them contain their own set of properties that are specific to the experience type.

Experience Type
Custom
Discord
File
Link
Content
Software

Below are example properties for each kind of experience:

Custom Experiences

With custom experiences you can showcase what really makes your pass special. These objects are super customizable. The properties are empty, just set the experience_name

{
  "id": "exp_**************",
  "experience_type": "custom",
  "name": "Custom Experience Name",
  "description": null,
  "properties": {}
}

Discord Experiences

Add automatic Discord roles with your access pass.

This experience's properties will contain the role ID the user will receive as well as the cancel action that will be run upon membership termination.
cancel_action can be either:

noaction which means do nothing
removerole which means remove this specific role
kickuser which means we kick the user from the Discord server
removeallroles which means we will remove all roles the user has, regardless of if we gave them out originally

{
  "id": "exp_**************",
  "experience_type": "discord",
  "name": "Role Name",
  "description": null,
  "properties": {
    "role_id": "65000000717819463",
    "cancel_action": "removerole"
  }
}

File Experiences

{
  "id": "exp_**************",
  "experience_type": "file",
  "name": "Image Name",
  "description": null,
  "properties": {}
}

Link Experiences

{
  "id": "exp_**************",
  "experience_type": "link",
  "name": "Link Name",
  "description": null,
  "properties": {
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "oauth": false
  }
}

Content Experiences

{
  "id": "exp_**************",
  "experience_type": "native_content",
  "name": "eli 2",
  "description": null,
  "properties": {
    "document_ids": [
      "doc_**************",
      "doc_**************",
      "doc_**************",
      "doc_**************",
      "doc_**************",
      "doc_**************"
    ]
  }
}

Software Experiences

Provide users a custom software or web app with their membership

This experience's properties will contain an array of download links.

links is an array of download link objects that are provided to the user. They each contain the downlink link (url`), version number, and platform.

Platform can be webapp, windows, mac, mac_m1, ios, android, other

{
  "id": "exp_**************",
  "experience_type": "software",
  "name": "Experience Name",
  "description": null,
  "properties": {
    "links": [
      {
        "url": "https://releases.bot.com/windows/latest",
        "version": 1.0,
        "platform": "windows"
      },
      {
        "url": "https://releases.bot.com/windows/latest",
        "version": 1.0,
        "platform": "mac"
      }
    ],
    "category": "general",
    "supported_sites": [],
    "supported_regions": []
  }
}