Integrate Your Hardware to Verify Members as they Arrive

This step by step tutorial will show you how to verify a membership card and check them in via our API.

Now that you or your vendor are looking to integrate their keycard/ID card solution with our digital and existing ecosystem, there are a few things to keep our environments in sync.  

To preface this article, these are some common use cases this can enable:

  • Member is approaching the space, notify staff they are arriving.
  • Member has lingered around a certain area for too long, send them a message.
  • When you become a member, you immediately gain access.
  • When your membership is no longer active, you immediatley gain access.
  • Add a paywall to physical spaces.

The integration is going to be a two-way integration between Peoplevine and your platform.  The best part is, you have full access to build this directly in Peoplevine without the need to modify your markup to accomodate our data.  In this integration, we're going to first notify your platform when a new member is activated (and/or canceled) so you can update your records to enable/disable access.  This will ensure our databases are in sync.  Then you will need to develop an integration to send us the member data as they check-in.  When doing this, not only will we track visit history on the member's profile, but staff will be immediately notified, systems like Sevenrooms will be notified upon arrival and an infinite amount of automation that you can configure. 

Member is Activated Member is set to Inactive (or cancels) Member Scans in At Door Control We send webhook with data We send webhook With data Sends data to PeopleV ine Member is reg istered in Security System Member is removed from Security System Activity stored in PeopleVine via ve rifyMe mbe hip API call Response includes Send confirm ation extemal ID for To PeopleVlne tracking We need the external ID we received when added along with location.

Get Notified/Data When a New Member is Activated (or Cancelled) to Activate in your System

First we'll get started with setting up the webhooks so you can get new members and member changes to update your system.  Start by going to the Automate suite in Peoplevine and click on Setup New Webhook.  Please note, if you have an expiring token, you will need to setup a new Webhook Auth.

A Webhook Auth enables you to enter the initiation URL, get token URL and refresh URL in an effort for our system to automatically generate that token when it expires.  Please note that your response should have an expires_in field with an integer in minutes.  We will then set this to expire at that time and once expired we will request a new token.

Once you have set this up, you can access the access token by including {@access_token@} in your header or body request.

Now that your Webhook Auth is in place, you will need to setup a webhook to leverage this (and test it out).  Start by clicking on Automate then New Webhook.

When setting up the webhook, you will need to first select the action that will trigger this.  In this case you are going to setup at least 2 triggers.  You want to setup 1) when a member is set to active - so you either register on your side and/or activate if was disabled. 2) when the membership is set to cancelled to disable their access and 3) when the membership changed (to get new membership ID).  You can setup additional as needed (but it's done one at a time).

After you selected which memberships (or all) to process this on, you will then need to setup the webhook to share the data.  Start by adding the URL and then attaching the credentials you created.   Once attached you can then reference the generated token by entering {@access_token@} in the header or body object.

Then select the fields you need in your call.  We currently pull available fields associated with the membersihp.  Some key fields that identify the member back in our system would be customer_no, membership_id and membership_card_no.  Please note the membership_id can change, while the customer_no will never change and the membership_card_no only changes when they have a new membership (not if they membership_id or something else changes). 

Once the webhook is saved (and set to active), any time a member is set to active (or cancelled) we will send you the requested member's data to your API endpoint using your API credentials.  

Once these are in place, any time a new member is activated (or existing switched back to activated), you will get a webhook with their info.  Then once they cancel, you'll be notified to deactivate.  Now that these are in place, lets focus on syncing member check-ins with our platform.

Sync Member Check-Ins with Peoplevine

When a member checks in to your hardware, you can leverage our verifyMembership API to confirm if they are an active member along with logging this data into the member's profile.  To do this, follow these steps:

  • View the verifyMembership API under the Membership Methods
  • Here's a sample object to pass to the API
        "location""Location of Scan",
        "verified_id": "Device ID",
        "scanner_type""Your System Name"

  • Alternatively, you can pass in the membership_id instead of the customer_no and membership_card_no. 

You will then receive a response that the membership was verified or if it failed for some reason.  This will be returned to you in a response object with isError = true or false and the details in returnObject.

Additional Help Tutorials

Find more ways to grow on PeopleVine.

Configure Salto to Work with Peoplevine Check-In

Follow these steps to configure your Salto to auto Check-In members when they use a Salto keycard.

Posted January 12, 2024

Detailed Member Statements & Billing

Unveiling Peoplevine's Member Statements & Billing feature: a comprehensive tool ensuring utmost transparency, simplicity, and efficiency in every financial transaction for both members and operators.

Posted September 28, 2023

New and Improved Timeline View

Dive into Peoplevine's My Schedule Timeline View: a feature designed to bring unmatched convenience and clarity to members' and guests' schedules, centralizing everything from dining to events.

Posted September 28, 2023

Spa & Wellness Booking with Book4Time Integration

Experience the perfect synergy of Peoplevine and Book4Time: a collaboration that transforms spa and wellness bookings, merging front-end engagement with backend efficiency.

Posted September 28, 2023

Going Global

Discover how PeopleVine's "Global Network" solution is set to revolutionize the hospitality industry by unifying brand experiences across multiple properties, whether globally or within a local region, offering members a seamless digital experience and granting operators unparalleled insights.

Posted September 28, 2023

Override the Guest Pass E-mail with Template

You can replace the e-mail sent to a guest when a guest pass is issued while retaining the necessary links to ensure they can activate it.

Posted September 27, 2023

Transaction Reporting has an Upgrade

We updated the Transaction Reporting screen to provide you with the data necessary to provide a glimpse at your revenue and the necessary data to audit your financials.

Posted September 7, 2023

You Can Set the Time to Process Authorizations

When a charge is processed through your POS, the charge may be Authorized until we capture the tip or at the end of day to handle refunds or changes. In this case, you can now set the time as to when we will process your authorizations.

Posted August 28, 2023

Adding Your Alliants Integration

Follow these steps to connect Peoplevine with your Alliants account for messaging.

Posted August 28, 2023

Setup Your Membership Tiers Based on Age

You can enable your membership tier to be for members between certain ages, when they past that age, they will automatically migrate to the next age tier.

Posted August 22, 2023

Follow these steps to update your Twilio settings to ensure delivery

This article will overview how to setup your brand and campaigns for broader/better delivery.

Posted August 10, 2023

Select Which Transaction Types You Want to Sync with Quickbooks

You're able to select which types of transaction items you want to sync to Quickbooks.

Posted June 14, 2023

Configure your Member Portal to Show Spa and Wellness

Once your Spa and Wellness feature is enabled, you need to configure the following to display on your member portal.

Posted June 14, 2023

Setup a Temporary ID for Hotel Guests

You can allow hotel guests to act as a member during their time at your property by leveraging these settings.

Posted May 23, 2023

© Peoplevine 2024. Powered by PeopleVine. Terms of use | Privacy & cookies