A webhook allows your sales to show up on Palmetrics almost instantly.

What is a webhook?

As per Takealot's documentation:

Webhooks are used to update the data in a particular system in real-time, based on events that occur in another system. i.e. they are a tool that assists in keeping the data in two different systems in sync, in real time. They work by sending notifications to a defined URL of the occurrence of an event that has occurred in a particular system.Instead of getting your app to make an API call every X number of minutes to check if a specific event has occurred, you can subscribe to webhook events which send a POST request from Takealot telling you the event has occurred and details of the event. This allows you to have more real time data with far fewer API requests.

What are the benefits?

In short, the benefits are:

1. You as a seller receive real-time sales updates on Palmetrics instead of a 30-min delay.
2. Far fewer redundant requests are made to Takealot's servers, which reduces the chances of your API key being blocked by Takealot due to excessive usage.

What information is shared via the Webhook?

The same information that Palmetrics can access via your Takealot API key is shared via the webhook - nothing more.

At this time, webhooks are only used to get immediate updates when your sales change state - e.g. from 'Preparing for Customer' to 'Shipped'.

What is a webhook URL?

A Webhook URL is the recipient destination that the sending system will send "event" updates to, which in this case is from Takealot -> Palmetrics.

So, you would enter Palmetrics' Webhook URL into your Takealot Seller Portal.

What is a webhook secret?

A Webhook secret is created by the sending system and allows the receiving system to verify that the request is legitimate, unaltered and originated from the sending system.

This secret should not be shared with anyone other than Palmetrics in this context.

How do I set up my webhook?

Setting up your webhook requires you to update settings on Palmetrics and your Takealot Seller Portal.

Below are the steps that you need to follow to complete this process: