Syncing customers in a Peoplevine Webhook

This section walks you through creating a Register as a new Customer webhook, and then synicing the information to verify it is working.

1. Login to the Peoplevine Control Panel.

2. Go to Automate -> Setup New Webhook.

3. Select the activity in Peoplevine that triggers the webhook, such as Register as a new Customer.

4. Define the information in The Basics section.

   • Webhook System: The name of the external system.

   • Webhook Name: A unique name for your webhook. It can be any name that you define.

   • Request Method: The type of request your endpoint expects to accept the data you will send to it with the webhook.

   • URL this Webhook will Request: Type the URL that the webhook should request in order to connect to the correct endpoint in your system.

   • Webhook Description: Write a description that precisely and uniquely describes the actions of this webhook.

   • Use Credentials: Select a credentials that has been previously defined in the Peoplevine Control Panel.

   • Webhook status: Either Active or Inactive.

   • Order Sequence: If you have multiple web hooks, you can set this one to run after a number of webhooks complete. This runs in priority order, so the lower number runs first.

   • Defer Processing: You can set the number of minutes to wait after the webhook criteria is met before this webhook starts processing. This can be set in order to allow other webhooks or jobs to complete before this webhook begins processing.

5. After defining when and how the webhook will run, define the data that will be contained in the payload in The Data section.

   • Setup Header Object: Define the header key value pairs (for instance, field_name: field_value) you want to include in the request. This can also include HAPI variables as defined above.

   • Data object checklist: You can select the data fields that you would like to include in the payload by checking the boxes next to the fields, selecting either In JSON Structure or Separated by Commas, and then clicking Generate Output at the bottom of the page. HAPI variables can be added as well.

   • Content Type: Select either JSON or Form Data. This defines how the data is sent to your system.

   • Save the ID: You can decide if you want to the save the ID when the webhook is successful. If you decide to save the ID, it will be parsed form the response and then linked to the record in Peoplevine.

6. Click Create. The webhook is created and your data will begin syncing immediately based on the parameters that you set.

7. To verify that the connection is active, navigate in the Peoplevine Control Panel to CRM -> View People.

8. Click the View button beside a user, preferably a test user.

9. Modify the data and then click Update Membership Card.

10. Verify that the data is updated in your system.

If you have any issues, please reach out to Peoplevine Support.

Example JSON output

{ 
   "profile_photo": "{@profile_photo@}",
   "first_name": "{@first_name@}",
   "last_name": "{@last_name@}",
   "address": "{@address@}",
   "address2": "{@address2@}",
   "address3": "{@address3@}",
   "city": "{@city@}",
   "state": "{@state@}",
   "zip_code": "{@zip_code@}",
   "phone_number": "{@phone_number@}",
   "email": "{@email@}",
   "username": "{@username@}",
   "birthdate": "{@birthdate@}",
   "anniversary_date": "{@anniversary_date@}",
   "company_title": "{@company_title@}",
   "customer_status": "{@customer_status@}",
   "customer_type": "{@customer_type@}",
   "gender": "{@gender@}",
   "isMember": "{@isMember@}",
   "wasMember": "{@wasMember@}" 
}