> For the complete documentation index, see [llms.txt](https://help.peoplevine.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.peoplevine.com/products/integrations-overview/setup-vizpin.md). # How to Connect VIZpin and Peoplevine The VIZpin integration uses **Peoplevine webhooks** to pre-register members in VIZpin, grant access when a member becomes active, and revoke access when a member cancels. This article covers the **Peoplevine Control Panel side** of the integration. VIZpin-side configuration (account/reader-ID provisioning, member-app rollout) lives in Peoplevine Connect — links are provided in each step. > Setting up Salto Space instead? See: [How to Connect Salto Space and Peoplevine](/products/integrations-overview/setup-salto.md). Building a custom or non-standard access-control integration? Use the [Access Control Integration with Peoplevine](https://docs.peoplevine.com/peoplevine-docs/peoplevine-connect) partner guide in Connect. ### Before you begin (Prerequisites) * **Permissions**: You must be an **Administrator** or **Supervisor**. See: [How to Manage Users and Permissions](/products/control-panel-overview/admin-overview/manage-roles-permissions.md). * **Peoplevine Control Panel** access. * A Peoplevine **business location** to associate with the connection. * Your VIZpin **Account ID**. * The **reader IDs** for the doors you want to control. * For how to find these IDs and how to set up your VIZpin app, see the [Connect VIZpin and Peoplevine](https://docs.peoplevine.com/peoplevine-docs/peoplevine-connect) guide. *** ### Setup #### 1. Confirm your VIZpin IDs Before you configure webhooks, have your **VIZpin Account ID** and **reader IDs** ready. Send these to your Peoplevine integration team — they configure the reader IDs against your business locations on the Peoplevine side. For where to find these IDs in the VIZpin portal, see the [Connect VIZpin and Peoplevine](https://docs.peoplevine.com/peoplevine-docs/peoplevine-connect) guide. #### 2. Configure the three webhooks in Peoplevine Set up three webhooks so member status changes flow to VIZpin. Use [How to Configure Webhooks](/products/integrations-overview/configure-webhooks.md) for the general webhook setup steps; for each VIZpin webhook, the event and endpoint are: | Webhook | When it fires | Endpoint | | --------------------------------- | ------------------------------------------ | ------------------------------------------------------------------- | | **Pre-Register VIZpin User** | A new member is added | `https://rest.peoplevine.com/api/partners/vizpin/user/pre-register` | | **Grant VIZpin on Active Status** | A new member is added and/or set to active | `https://rest.peoplevine.com/api/partners/vizpin/user/grant` | | **Revoke VIZpin on Cancellation** | A member cancels | `https://rest.peoplevine.com/api/partners/vizpin/user/revoke` | > **Tip:** You may also want the **Revoke** webhook to fire when a member fails billing or moves to a pending status. Confirm the desired scope with your team before enabling. #### 3. Inform your members about the VIZpin app Once a new member is set up for the first time, Peoplevine pre-registers the member's mobile number with VIZpin. The member must use that same mobile number when registering with VIZpin. We recommend emailing your members with instructions to download the VIZpin app. Inside the app: 1. The member taps **Existing user**. 2. Then taps **Forgot password** to receive a PIN. 3. They log in with the PIN, set a new password, and immediately see all available keys. For the full member-facing rollout guidance, see the [Connect VIZpin and Peoplevine](https://docs.peoplevine.com/peoplevine-docs/peoplevine-connect) guide. *** ### What Gets Synced | Data | Direction | Notes | | ------------------------------ | ------------------- | ----------------------------------------------------- | | Pre-registration of new member | Peoplevine → VIZpin | Fires when a new member is added; sends mobile number | | Access grant on active status | Peoplevine → VIZpin | Fires when a new member is added and/or set to active | | Access revoke on cancellation | Peoplevine → VIZpin | Fires when a member cancels | > **Note**: The VIZpin webhooks are one-directional from Peoplevine to VIZpin. Reader-side activity is handled in the VIZpin platform, not Peoplevine. *** ### Troubleshooting **Member is not pre-registered or does not see keys** Confirm all three VIZpin webhooks are saved and enabled in Peoplevine, and that the member's mobile number on the Peoplevine profile matches the number they used to register in the VIZpin app. **Access not revoked on cancellation** Confirm the **Revoke VIZpin on Cancellation** webhook fired for the member. If you also want revoke to fire on billing failure or pending status, that scope must be added explicitly to the webhook configuration. For hardware- or portal-side troubleshooting (VIZpin app behavior, reader provisioning), refer to the [Connect VIZpin and Peoplevine](https://docs.peoplevine.com/peoplevine-docs/peoplevine-connect) guide or your VIZpin support contact. *** ### Best Practice * **Test with a single member first.** Pre-register one member, verify the grant fires on activation, then test the revoke on cancellation before rolling out to your full base. * **Decide your revoke scope early.** Decide whether **Revoke VIZpin on Cancellation** should also fire on billing failure or pending status, then configure the webhook accordingly. *** ### What Happens Next Once webhooks are live, member access updates automatically — new members are pre-registered and granted access, cancelled members have access revoked. Members manage their VIZpin keys in the VIZpin app. * Peoplevine Connect: Access Control hub README (origin/connect-integrations, commit fcc9870, 2026-04-29) * Peoplevine Connect: Connect VIZpin and Peoplevine (origin/connect-integrations, commit 188f96e) *Last updated: 2026-05-24* --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.peoplevine.com/products/integrations-overview/setup-vizpin.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.