Using webhooks

This is an advanced topic that requires a developer on your end to understand.

For directions on adding webhooks, go here.

Webhooks send order / sign-up data from Hyax into a product of your choosing through a JSON payload. 

If you are using webhooks, please note that you should have a programmer on board that understands how webhooks work. 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 anyway 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 through 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 Hyax, 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 Hyax 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 Hyax are NOT sent into your 3rd party system. This is because passwords are secured by a proprietary hashing algorithm inside Hyax 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": "[e-mail]" <user's email>,
"order_id": "200" <order id inside Hyax>,
"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 Hyax>,
"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"
}