Requirements:
A paid subscription to Zapier (Webhooks by Zapier is a premium feature for paid accounts)
A PassKit Account
Using Webhooks with PassKit:
With PassKit, you can receive real-time notifications when a pass is:
Created by a user - the pass payload will be sent to destination when pass record is created and issued
Updated by a user - the pass payload will be sent to destination when pass record or contents have been updated
Installed by a user - the pass payload will be sent to destination when pass is installed on a mobile device.
Uninstalled by a user - the pass payload will be sent to destination when pass is uninstalled from a mobile device
Deleted by a user - the pass payload will be sent to destination when pass record is deleted from the PassKit database
These notifications can be used for Membership, Loyalty, Coupons, and Event Tickets.
Examples of Webhook Use Cases:
Created by a User:
Welcome Emails: Send welcome emails with pass links via your email marketing software.
CRM Integration: Add pass holder information to your CRM software.
Updated by a User:
Tier Adjustment: Change a user's tier based on pass changes (Membership/Loyalty).
CRM Update: Update pass holder information in your CRM software.
Check-In/Check-Out: Send relevant emails (e.g., hotel details, visit surveys) (Membership/Loyalty).
Installed by a User:
Reward Points: Issue points to thank pass holders for downloading the card (Membership/Loyalty).
Uninstalled by a User/Deleted by a User:
Feedback Request: Send surveys or emails asking for feedback.
Data Cleanup: Delete the pass from PassKit and remove the pass holder from your CRM software.
Setting Up the Webhook:
To begin login to your Zapier account and create a new zap.
Choose the trigger for your zap. In this case, select "Webhooks by Zapier" by searching for "webhook" in the search bar.
Configure the Webhooks by Zapier trigger:
Select "Catch Hook" as the trigger option
Click "Continue" to set up what data you want to receive from the webhook request. You can specify specific data, such as "pass" or "personDetails"
Continue to obtain the endpoint URL for the webhook, which will be used in the next step
Log in to your PassKit account to set up the webhook sent to Zapier:
Navigate to the project you want to use for the webhook and click on "Settings" in the top bar
Click on "Webhooks" in the integrations section
Select "Add Webhook"
Choose when you want the webhook to trigger and paste the webhook URL from step 3 into the "Endpoint URL" box
Click "Create webhook" to complete the setup. You should see it added to your list of webhooks for you project
Testing the Zapier Integration:
If you want to test the webhook with Zapier, you'll need to create, update, install, uninstall, or delete a pass based on your selected webhook options. For this example, you can create test data by update a user's points manually through the members section after clicking "Edit Member."
Return to Zapier to finish the zap:
If you've generated test data for Zapier, navigate to where you copied the webhook URL and select "Test Trigger." You should see a confirmation message
Continue by selecting the next software you want to integrate with. In this example, we'll integrate with Filter with Zapier and PassKit Membership to change a member's tier when they have over 100 points, to begin with select Filter by Zapier
Use "Filter by Zapier" to set up filters based on conditions like "Pass Record Data Members Member Points" and "Pass Record Data Members Tier Name"
Ensure that your test data meets these conditions to proceed
Select "PassKit Membership" as the final action in your zap
Choose the event "Change Tier" and follow the prompts
Log in to your PassKit account through Zapier if you haven't got any existing Zaps with PassKit
Fill in the member details, including the PassKit Generated Member Id (select "Pass Id" from step 1), Program Id (project id for the member's program), and Tier Id (the desired new tier)
Click "Continue" to test the step and ensure the member's tier changes as intended
If everything works as expected, you can publish the Zap to activate it and automatically change members' tiers based on their points.