Introduction to Webhooks

Webhooks are a system of automated notifications indicating that an event has occurred on your website.

Rather than requiring you to pull information via API, webhooks push information to your destination when important events occur.

You can create webhooks for:

1. New Order (order_created) - fired when a new order is placed on the website

2. Updated Order (order_updated) - fired when an order is updated

3. New Product (product_created) - fired when a new product is created

4. Updated Product (product_updated) - fired when a product is updated

5. New Form Submission (form_submitted) - fired when a form is submitted

6. New Contact Activity (contact_updated) - fired when a new contact is created or an existing contact is updated

To create a webhook, go to Website Settings > Applications, then click on "Add Application".

In the following prompt, fill out the URL to call on one of the events above and select the events to listen for.

That's it! On one of the selected events, we will make a POST request to your destination URL with the details of the event.

Your destination URL should acknowledge that the request was accepted by returning a status code HTTP 200.

Failure to return code in the 2xx range will be considered a failed request and an e-mail will be sent to the owner of the website, notifying the error.

Optionally, use the webhook secret to ensure that each request to your destination URL is sent by us.

More information, details on the format of the data sent and all additional request headers can be found in our API docs on this website: https://websitebuilder.docs.apiary.io/#reference/webhooks