Webhook Notifications

Upon completion of various operations, Pleenk posts notifications to the registered Marketplace webhook.

These notifications are essential for keeping the Marketplace updated on significant events such as user actions, payment processing, and approval statuses.

Notification Format

• Method: POST
• Content Type: application/json
• Payload: JSON stream

Security

The notification payload is signed with the Pleenk private key to ensure data integrity and authenticity. The signature is included in the HTTP header named pleenk-signature.

Webhook URL

All notifications are sent to a unique webhook URL registered with Pleenk. Notifications may be batched, meaning several events can be included in one webhook POST request.

Example Notification Payload

{
  "events": [
    {
      "eventType": "USER",
      "data": {
        "@type": "USER_EVENT",
        "ref": "8d1c7d19-7883-4ee6-8e90-f5c4f4fc3957",
        "status": "LINKED"
      }
    },
    {
      "eventType": "PAYMENT",
      "data": {
        "@type": "PAYMENT_EVENT",
        "transactionRef": "12345",
        "paymentId": "abcde",
        "privacyScope": "private",
        "metadata": "metadata",
        "status": "CONFIRMED",
        "beneficiaries": [
          {
            "ref": "beneficiary1",
            "amount": 100.00
          }
        ]
      }
    }
  ]
}

 

Summary

By implementing webhook notifications, you can keep your marketplace synchronized with the latest events from Pleenk. Ensure you verify the signatures to maintain security and trust in the notification data.