🤝 Group Payment Webhook Events

Hands In supports a real-time webhook notification system so your system can stay in sync with payment activity. You can subscribe to a set of webhook events to receive updates when key actions occur within a session.

🛠️ Setting Up a Webhook

To add a webhook:

1. Log in to your Hands In Merchant Dashboard.
2. Navigate to Developers > Webhooks
3. Click Add Webhook.
4. Provide the following:
   • A webhook name
   • A URL where you wish to receive POST requests. (must be HTTPS - can use tunnel services like ngrok for development/testing )
   • Lastly, select the group payment events you wish to subscribe to from the dropdown list

📋 Group Payment Webhook Event Types

Use the dropdown during webhook setup to subscribe to any of the following events:

📦 Group Payment Example Webhook Payload

When an event is triggered, Hands In sends a POST request to your webhook URL with the following payload:

{
  "id": "eventId",
  "eventType": "GROUP_PAYMENT_CREATED",
  "merchantId": "merchant_456",
  "createdAt": "2025-05-06T12:00:00Z",
  "groupPaymentId": "groupPayment_712",
  "data": {
    // ... event-specific object (e.g., group payment session)
  }
}

You can then perform your business logic accordingly based on the eventType.

For example, when you receive GROUP_PAYMENT_COMPLETED, you might want to email all the paid customers from your system with the necessary information.