Table of Contents

Auto-enrolment

Kate Santo Updated by Kate Santo

Auto-enrolment is a handy functionality within the Padoq platform. It allows brand admins to create a list of padoqs that users will be added to automatically when they join the app.

Here's an example use case:

In a property app, there might be padoqs set up for tenants to communicate amongst themselves, a resident marketplace, a padoq to report issues, etc. The brand admin for the app can decide that it's important for every tenant to belong to a selection of padoqs. Those that are essential for communication and maintenance, for example.

When auto-enrolment is set up, each new app user will become a member of the selected padoqs. Also, if auto-enrolment is set up or updated at any point, the next time that existing members log in, they will be added to the selected padoqs too.

See for yourself

  • You can download the iOS or Android app on your phone to follow this journey along. And you can also log in or sign up to the web app here
  • If you have access to the CMS (Content Management System), you can see what brand admins see by logging into it and going to "Auto enrollments" on the left
  • You can also follow along by checking out the images or code snippets in this guide
  • And you will find the relevant endpoints linked and explained in this guide, but the full API is documented in Swagger UI

Creating auto-enrolments

Creating auto-enrolments is done via the createAutoEnrollment endpoint. It takes just one parameter, namespace, which specifies which app or namespace the auto-enrolment is for.

It returns a response like this:

{
"id": "1234abcd-5648efgh-9012abcd",
"updated": "2020-03-20T11:57:16.257Z",
"padoqs": [
"your-building",
"community",
"report-issues",
"concierge",
"resident-marketplace"
],
"triggerQl": "query PadoqByName($name: String!) {padoq(name: $name) {name}}",
"triggerVariables": {
"name": "lunch-room"
}
}

Reading auto-enrolments

The getAutoEnrollments endpoint takes namespace as a parameter and returns all of the auto-enrolments in that namespace.

In the UI, the response looks like this:

When the brand admin opens one of the auto-enrolments, the below view comes up. The auto-enrolment id is at the top, the updated timestamp appears next and the padoqs inside that auto-enrolment come last:

Updating auto-enrolments

The updateAutoEnrollment endpoint takes the id of the auto-enrolment that's being updated. When an auto-enrolment is updated, the timestamp of when that happens is stored in the updated property.

So when users log in after that time, they are automatically added into any padoqs there weren't a member of. However, if a user is a member of a padoq that is then removed from auto-enrolment through an update, the user continues to be a member of that padoq.

Deleting auto-enrolments

The deleteAutoEnrollment endpoint takes the id of the auto-enrolment that needs to be deleted. It returns success or failure messages.

How does auto-enrolment work for the user?

When an app has auto-enrolment set up, users will join each padoq in different ways depending on whether autoAlias is true or false in the padoq settings:

  • If autoAlias is true: the app will use the user's default persona for enrolment. This means that the user's persona name and avatar will be created automatically and they won't be able to change them
  • If autoAlias is false: users will update their persona name and avatar as they enter each new padoq for the first time

How did we do?

What are Padoq categories?

Verified by Padoq

Contact