Webhooks

Webhooks Signature

The X-Jeel-Signature header is a security measure used in webhook responses to guarantee that the data received is from our platform and has not been tampered with during transit. It is created using the HMAC (Hash-based Message Authentication Code) algorithm with base64 encoding, using the client_secret as the secret key and the webhook body json as the message. The header is then added to each webhook request, allowing you to verify the integrity of the received data.

Webhook Body

The webhook body you'll receive contains the request ID and the new status of it.

Checkout type: SCHOOLING

{
  "checkout_id": "9e79d502-231d-449b-b419-a674b687df51",
  "status": "SUCCEEDED",
  "checkout_type": "SCHOOLING",
  "metadata": {
    "example_key_1": "example value 1",
    "example_key_2": "example value 2"
  }
}

Checkout type: ITEMS

{
  "checkout_id": "9e79d502-231d-449b-b419-a674b687df51",
  "status": "SUCCEEDED",
  "checkout_type": "ITEMS",
  "metadata": {
    "example_key_1": "example value 1",
    "example_key_2": "example value 2"
  }
}

Examples on Calculating the Signature

Java

private String calculateSignature(String clientSecretKey, WebhookDto webhookBody) {
  Gson gson = new Gson();
  return Base64Utils.encodeToString(
      new HmacUtils(HmacAlgorithms.HMAC_SHA_256, clientSecretKey).hmac(gson.toJson(webhookBody))
    );
}

PHP

Javascript