This is an advanced topic that may require a developer on your end to understand.
For directions on adding webhooks, go here.
Webhooks send order / sign-up data from Hy.page into a product of your choosing through a JSON payload.
We suggest having a developer help with this as we cannot help with technical implementations except in cases where an error is happening on our end.
So if you're building a custom app/integration, you can receive this JSON data and use it basically in any way you like.
For example
- You can take sign-up data and register that user into a 3rd party SaaS system
- You can add that data through Zapier to any apps that connect with Zapier
- You can send that data to an ESP (email service provider)
When can you fire a webhook?
In Hy.page, you can fire a webhook to a URL of your choosing after someone purchases or signs up to your store, funnel, membership plan, or course.
This a good way to integrate Hy.page into your product, or hook up something like Zapier by webhooks.
After an opt-in (sign up)
Here's the JSON payload that gets sent to your webhook URL. Please note the content inside the < > are just explainers.
{
"first_name": "John" <user's first name>,
"last_name": "Smith" <user's last name>,
"email": "Email" <user's email>,
"date": "1590616723" <timestamp for date>,
"<additional_field1>": <any additional fields you add for your form>,
"<additional_field2>":<any additional fields you add for your form>,
"<additional_field3>":<any additional fields you add form>,
...<any other fields you add>
}
* Please note that PASSWORDS created by Hy.page are NOT sent into your 3rd party system. This is because passwords are secured by a proprietary hashing algorithm inside Hy.page for security. This means if you need a password, you need to create a mechanism on your end that generates a password on your side.
After a purchase
Here's the JSON payload that gets sent to your webhook URL. Please note the content inside the < > are just explainers.
{
"first_name": "John" <user's first name>,
"last_name": "Smith" <user's last name>,
"email": "email@email.com" <user's email>,
"order_id": "200" <order id inside hypage>,
"subtotal":"100.00" <subtotal of the order>,
"tax":"10.95" <tax assessed>,
"vat":"0" <vat assessed>,
"discount_amount":"20" <total discount amount>,
"order_total": "100" <order value>,
"coupon_used": "100BUCKSOFF" <coupon name value>,
"payment_gateway": "stripe" <stripe or paypal>,
"billing_address": "911 Street",
"billing_address_line_2": "apt 20",
"billing_city": "New York City",
"billing_province_state": "NY",
"billing_country": "United States",
"billing_zipcode": "90012",
"shipping_id": "1999", <Shipping ID inside hypage>,
"shipping_option": "Domestic Priority", <Shipping title that corresponds to the Shipping ID above>,
"shipping_address":"911 Street",
"shipping_address_line_2":"apt 20",
"shipping_city": "New York City",
"shipping_province_state": "NY",
"shipping_country": "United States",
"shipping_zipcode": "90012",
"phone_number": "923-943-2444"
}
Using Zapier
Connecting with Zapier (by webhook)
Besides having tons of built-in integrations, we also allow you to connect with Zapier to do more things with your data and connect to more tools that we don't have direct integrations with.
Zapier allows you to pass data from Hy.page to a 3rd-party. We use Zapier's "webhooks" to send data to Zapier, which you can then send to most email marketing services.
Before you start, there are 2 major steps to getting the integration to work:
1.) Get the webhook URL from Zapier
2.) Add it into Hy.page
PART 1 - Getting the webhook URL from Zapier
In this example, we're going to do an example integration from Zapier to Hubspot, so you can see how we pass data to Hubspot using Zapier.
Step 1 - Register / Login on Zapier
If you haven't done so yet, register on https://zapier.com/sign-up/
Step 2 - Make a Zap!
After you signup (or login) click on the orange button on the top right labeled "Make a zap!"
Step 3 - Name your zap
I chose the descriptive name "Hy.page to Hubspot" for this example. You should use something like Hy.page to <your email marketing service> to make it easy to remember.
Step 4 - Choose Webhooks
Now on the following page, in the search bar, under "Choose a trigger app", type "webhook". The first suggested result will be "Webhooks by Zapier". Click on it.
Step 5 - Catch hook
In the next step choose "Catch Hook" and click "Save + Continue".
Step 6 - Skip
In this screen leave the field blank and click "Continue".
Step 7 - Copy webhook URL
On this page Zapier will give you a webhook URL. Copy THIS URL.
PART 2 - Adding the webhook URL to Hy.page
1) Go to the settings on the left-side navigation. Then click on payment gateway & integrations.
2) Then scroll down and add a webhook.
3) Then add the Zapier webhook url into the popup that appears and save.
4) Make sure to test your webhook after entering it!
Comments
0 comments
Please sign in to leave a comment.