Webhook Documentation

Introduction

TransactAPI has webhooks which help you get notifications when TransactAPI methods respond with success. By using these webhooks, this alleviates the need to request a "get" method continuously to check on a status.

What is an webhook?

A webhook (also called a web callback or HTTP push API) is a way to exchange real-time information and updates automatically within two systems. Webhooks receive calls through HTTP POST requests only when the connected external system has a data update. APIs will place calls for data whether there's been a data update response, or not. This makes webhooks much more efficient for both provider and consumer.
While webhooks are an effective tool, they require an Internet connection between the data source and the web server to function. Additionally, a script must be present on the server at the destination URL and it must be able to recognize and parse the POST data. If the Internet connection or script is not available, the webhook will not work.

Creating webhooks and notifications

To create a webhook:

1. Add the script URL in your admin panel under webhook menu in the dashboard for a particular API method. You can enable/disable notifications to be sent through email and SMS.

2. Add notification and add email and/or SMS notification in your admin panel under the notification list menu in the dashboard.

*Sample Code

if ($conn->connect_error) 
    {
    die("Connection failed: " . $conn->connect_error);
                                                       
    }
if (isset($_POST['partyId'])) 
    {
    $partyId = $_POST['partyId'];
    $offeringId = $_POST['offeringId'];
    $orderStatus = $_POST['orderStatus'];
    $insert = mysqli_query($conn, "INSERT INTO checkworld (partyId,offeringId,orderStatus) VALUES ('$partyId','$offeringId','$orderStatus')") 
    or die(mysqli_error($conn));
    print_r($insert);
    }

Webhook Method List

Below is the complete list of webhook methods available in the TransactAPI.