Webhook Reference

Introduction

This section provides details about the notifications you receive when any of the Branch webhooks that you have registered for is triggered. There are common fields sent for all webhooks, and a payload that differs according to the webhook.

The example below shows the common fields at the top, then the payload specific to the webhook contained in the data block, which is sent to you encrypted. Each webhook example includes only the data block.

{
  "event": "WALLET_CREATED",
  "event_id": UUID,
  "client_type": "ORGANIZATION",
  "client_id": "100000",
  "data": {
    "employee_id": "123",
    "account_number": "1234567891234567",
    "routing_number": "084106768",
    "onboarding_link": "https://branchapp.com/ol1"
  }
}      

Test with Postman

Easily test Webhook integrations by downloading the pre-configured Webhook Events Postman collection. Just set your organizationID and apiKey in the collection variables.

To see more examples and details about how to make simple test calls using Postman, see Triggering Sandbox Webhook Events