Every Jumpseller store has the option to communicate with other services or websites whenever an specific event (like an order payment) happens.
These "webhooks" can be used, for example, to update an external invoicing system, CRM service or fire an alert to your employees via IM or SMS.

When a webhook is triggered it will POST a request, containing data in JSON format, to the specified URL.

The following events can trigger a webhook notification:

  • Order Created - when a new order is created
  • Order Paid - when your store receives a payment confirmation
  • Order Shipped - when you ship the order to your customer
  • Order Canceled - when, either you or a payment gateway, cancels an order
  • Order Updated - whenever an order changes state, this includes: creating, payment, fullfilment (shipping) and cancelation events


  • On every event we will POST a JSON formated message to your URL.
  • For example, if the event was an order created the message would look like:

    "status":"Pending Payment",
    "payment_method_name":"Cash Collection",
    "shipping_method_name":"Flat Rate",
    "payment_information":"Pay at your door step",
    "additional_information":"Leave at reception if not home.",
    "customer":{ "email":"test@gmail.com", "phone":"123"},
    "shipping_address":{ "name":"John", "surname":"Mattos", "address":"Colliers Wood", "city":"London", "postal":"5000", "country":"Britain (UK)", "region":"London"},
    "billing_address":{ "name":"John", "surname":"Mattos", "address":"Nok Ltd", "city":"London", "postal":"5771", "country": "Britain (UK)", "region":"London" },

  • We expect an HTTP response with status code 2xx, otherwise we will retry delivery other 9 times over more than 4 days ( N^4 where N is the retry attempt number, p.e. the third retry is scheduled in 3 * 3 * 3 * 3 = 81 mins and then the fourth in 256mins )

  • After 10 failed attempts to deliver a message we delete the problematic Webhook permanently and automatically notify the Store Admin by email.

PHP Examples

  • Example: Receiving an Order Paid notification

    $post = file_get_contents('php://input'); //post data is in another format (e.g. JSON, etc.)
    file_put_contents("jumpseller_postorder.txt", $post, FILE_APPEND); //store data locally (JSON to a file in this case)
  • Parsing the Order Paid notification

    $post_data = file_get_contents("jumpseller_postorder.txt"); //read JSON file
    $json_data = json_decode($post_data, true); //Takes a JSON encoded string and converts it into a PHP variable.
    echo $json_data['order']['id'];
    echo $json_data['order']['customer']['email'];


We recommend using this free services while testing Webhooks:

  • requestb.in to create an URL and display the received POST requests from your store and
  • jsonviewer to inspect JSON data in a human-friendly way.