# Subscribe to Group Payment Webhooks (/docs/guides/group-payment/group-payment-webhooks) 

# 🤝 Group Payment Webhook Events [#-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 [#️-setting-up-a-webhook]

<img src="/docs-assets/dashboard-webhook-create-group-payment.png" alt="The webhook endpoint dialog with the Group payments events listed and Group payment completed selected" />

To add a webhook:

1. Log in to your [**Hands In Dashboard**](https://app.handsin.com) and open your merchant.
2. Go to **Developers** and select the **Webhooks** tab.
3. Click **Add endpoint**.
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**](https://ngrok.com/) for development/testing )
   * Lastly, select the **group payment events** you wish to subscribe to from the events list, under **Group payments**
5. Click **Save endpoint**.

<Callout type="warn">
  **Note:** Before going live, you will need to register webhooks for both sandbox and live environments separately.
</Callout>

## 📋 Group Payment Webhook Event Types [#-group-payment-webhook-event-types]

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

| Event Type                | Description                                    |
| ------------------------- | ---------------------------------------------- |
| `GROUP_PAYMENT_CREATED`   | A new group payment session was created.       |
| `GROUP_PAYMENT_UPDATED`   | An existing group payment session was updated. |
| `GROUP_PAYMENT_APPROVED`  | The group payment session was approved.        |
| `GROUP_PAYMENT_COMPLETED` | The group payment session was completed.       |
| `GROUP_PAYMENT_EXPIRED`   | The group payment session has expired.         |
| `GROUP_PAYMENT_CANCELLED` | The group payment session was cancelled.       |

<Callout type="info">
  For a full list of events across the platform, see [Webhook Event Reference](/docs/webhooks/webhooks-events) for more details.
</Callout>

## 📦 Group Payment Example Webhook Payload [#-group-payment-example-webhook-payload]

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

```json
{
  "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.

***