How to set up your API through Webhook (Postback)

Webhook is the tool used to integrate the notifications of Hotmart with other systems. It automated the sending of a POST notification to the URL(s) registered by the Producer in our platform, according to the update of a transaction status.

For example, if a Producer makes the content of a product available in an external members’ area, Webhook releases the client’s access to the product as soon as the transaction status is “order approved”.   

Learn about the available resources to the Producer who chooses to deliver the access through POST notifications and how to set them up:

Adding new settings:

1. Access your Hotmart account through the link;

2. From the side menu, click on Tools 

3. Click on Webhook 

4. In the next screen, you will be able to add your configurations by clicking on the “+” symbol 

5. Set up the new configuration

In this screen you must insert the name of the segmentation, and select the events.

The available events are: order cancelled, order complete, bank slip printed, order approved, refund request, order refunded, chargeback, cart abandonment, and order expired.

The, select if you want the segmentation to be applied to all your products or only a specific product, and insert the sending URL.

Tip: you may explore these events to create important segmentations for your business. For instance, a segmentation for recovering sales, selecting refund requests, chargebacks, overdue subscriptions, and so on.

6. Click on Save 

You may create as many configurations as you wish, edit, disable or remove them from your list. To do so, just select the button that corresponds to the action on the right-hand side 

OBS: If the inserted URL contains any errors, the configuration will be disabled automatically so that new notifications are not sent unnecessarily.

Creating the integration:

Inside the Webhook menu, you will find all the necessary documentation to setup your integration.

Just click on the tab Documentation and see the parameters used to generate the notifications. You will find the following information:

  • name of the parameter
  • if the information is sent to the affiliate or not
  • the description and explanation of the parameter
  • format and size.

On this tab, you will also find the verification and security token.

Warning: to put this integration into effect, we recommend you ask for the help of a programmer or that you have programming knowledge, OK?

Monitoring the sending of posts:

From the Webhook menu, you will find the tab History

There you will be able to monitor all the sendings made and their statuses. The posts containing errors will be reprocessed until they get a positive response from the server, or 5 attempts are made. If you wish to reprocess it once again, just click on the button to the side of the post 

The statuses will always be indicated by HTTP codes. If you have found any status number you don’t recognize, just consult this link.

On History tab, you can also view the Payload and Responses set to that notification. In other words, the load of relevant information that has been sent in that event and what the response from the notified system was.

For instance, the load information sent was product, status, transaction, and affiliate, and the response given by the producer’s system was status OK.

Warning: if you already used Webhook (Postback) before the update, you will be able to consult the posts sent before the update. To do so, just click on the the tabs Sent Posts or Pending Posts  

If you still have any questions, or are facing any problems concerning this process, contact our Support! We are at your disposal to help!

Was this article helpful?
0 out of 3 found this helpful
Have more questions? Submit a request