Webhook Events

All important activity on your ZWITCH account is recorded as an event. We use webhooks to notify you about important events on your account. These webhooks contain details about the event such as changes that occurred and the resources impacted by the change.

We send webhooks as HTTP POST call to a URL configured by you. Webhook payloads use the JSON format.

Learn how to set up webhooks.

Available Webhooks

The table below lists the various webhook events triggered when creating and managing a beneficiary.

Webhook Events	Description
beneficiaries.created	Triggered when a bank account or VPA beneficiary is successfully created.
beneficiaries.updated	Triggered when the Update Beneficiary API call is successfully made.
beneficiaries.deleted	Triggered when the Delete Beneficiary API call is successfully made.

Sample Payloads

Beneficiaries Created

Triggered when a bank account or VPA beneficiary is successfully created.

{
  "id": "evl_6L1VenKPoAYMlZXVms8wIdbyN",
  "object": "event",
  "name": "beneficiaries.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "sab_njKY6N9RF6F3jpMGcc1udhDkI",
      "object": "beneficiary",
      "type": "account_number",
      "name_of_account_holder": "Anil Reddy",
      "email": "[email protected]",
      "phone": "9876543210",
      "bank_account_number": "501000012345678",
      "bank_ifsc_code": "HDFC0000123",
      "bank_name": "hdfc",
      "vpa": null,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "created_at": 1656337145,
      "is_sandbox": true,
      "account_id": "sa_bBcxZrS760zeIUgqyNYIjT0p5"
    }
  }
}

Beneficiaries Updated

Triggered when the Update Beneficiary API call is successfully made.

{
  "id": "evl_McXcu6NHwBq0SQd0s2s7x4a2V",
  "object": "event",
  "name": "beneficiaries.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "sab_njKY6N9RF6F3jpMGcc1udhDkI",
      "object": "beneficiary",
      "type": "account_number",
      "name_of_account_holder": "Anil Reddy",
      "email": "[email protected]",
      "phone": "9876543210",
      "bank_account_number": "501000012345678",
      "bank_ifsc_code": "HDFC0000123",
      "bank_name": "hdfc",
      "vpa": null,
      "metadata": {
        "key_1": "updated_DD",
        "key_2": "updated_XOF"
      },
      "created_at": 1656337145,
      "is_sandbox": true,
      "account_id": "sa_bBcxZrS760zeIUgqyNYIjT0p5"
    }
  }
}

Beneficiaries Deleted

Triggered when the Delete Beneficiary API call is successfully made.

{
  "id": "evl_oWo3RNIkcFF3p2minTjqQgTOq",
  "object": "event",
  "name": "beneficiaries.deleted",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "sab_njKY6N9RF6F3jpMGcc1udhDkI",
      "object": "beneficiary",
      "deleted": true,
      "account_id": "sa_bBcxZrS760zeIUgqyNYIjT0p5",
      "deleted_at": 1656400059
    }
  }
}