Examples

Webhook Examples

Generating Signatures

For secret key = "secret_key" and webhook:

content-type: "application/json"
signature: "1d0e480e14922b2e330216b2d34b3b9998267067143cf9ef7caaf3637de0307f207b7c6b1cd94ece313366baa24014c488796eef3dabbe8e60e7d1e72c73918d"

{
  "event": "order.created",
  "event_date": "2021-08-13T09:16:35+03:00",
  "order_id": 5555555,
  "order_name": "A0005555555",
  "status": "not paid",
  "external_id": "TEST12025",
  "create_date": "2021-08-13T09:16:35+03:00",
  "pay_date": "",
  "currency": "EUR",
  "locale": "en_EN",
  "order_detail_url": "https://shop.checkout.noventiq.com/order/status/5555555/1a97507",
  "customer": {
    "country": "FR",
    "type": "physical",
    "email": "customer@gmail.com",
    "first_name": "Marcel",
    "last_name": "Laporte",
    "phone": "",
    "vat_number": "",
    "company_name": "",
    "company_billing_address": "",
    "company_delivery_address": ""
  },
  "product": {
    "id": "111111",
    "vendor_code": "0001",
    "sku": "0001",
    "business_segment": "b2c",
    "name": "Demo",    
    "price": "100.00",
    "quantity": 1,
    "discount_percent": "",
    "discount_amount": "",
    "vat_amount": "0.00",
    "amount": "100.00",
    "margin": "90.00"
  },
  "payment": {
    "payment_method": "CreditCard",
    "payment_system_name": "Bank Card",
    "card_type": "",
    "card_last_4": null,
    "card_expiration_date": "",
    "is_card_expired": false,
    "is_installment_payment": false
  },
  "document_part": "1-of-1"
}

Concatenate the secret key and the parameter values from the request body using the template:
[secret key];[event];[order_id];[create_date];[payment_method];[currency];[customer.email]
Result:

secret_key;order.created;5555555;2021-08-13T09:16:35+03:00;CreditCard;EUR;customer@gmail.com

Apply SHA-512 hash to the string you get.
Result:

1d0e480e14922b2e330216b2d34b3b9998267067143cf9ef7caaf3637de0307f207b7c6b1cd94ece313366baa24014c488796eef3dabbe8e60e7d1e72c73918d

Check that the result you get matches the signature in the HTTP header of the webhook.

Order created (order.created)

This is an example of the Order Created webhook.

NOTE: There is no information about a subscription, since the subscription will be created upon the order payment completion.

Order paid (order.payment.succeeded)

This is an example of the Order Payment Succeeded webhook.

Payment error occurred (order.payment.failed)

This is an example of the Order Payment Failed webhook.

NOTE: There is no information about a subscription, since the subscription will be created upon the order payment completion.

Product license information sent to customer (product.delivered)

This is an example of the Product Delivered webhook. The system sent license information to the customer. The order becomes fulfilled and receives the Delivered status (status Paid remains in the notification) if it contains only one product.

Product license information returned or replaced (product.returned)

This is an example of the Product Returned webhook (including a refund or a chargeback). The product license information and the order has been refunded fully, the order has been deleted, the subscription renewal has been cancelled.

Subscription cancelled (AR / AR Trial / PMR) (subscription.cancelled)

This is an example of the Auto-Renewable Subscription Cancelled webhook.

Subscription resumed (AR / AR Trial) (subscription.restored)

This is an example of the Auto-Renewable Subscription Restored webhook.