Webhooks

In this guide, we will look at how to register and consume webhooks to integrate your app with Wealth.com.
With webhooks, your app can know when something happens in Wealth.com, such as a client accepting an invitation or completing an estate document.

The Wealth implementation of web hooks is at-least-once delivery and will submit a POST request with form encoded data to an encrypted endpoint.

Registering webhooks

Each customer will provide a URL for the webhook delivery target and Wealth.com will provide an API key.
Every customer will have a unique API key that will identify Wealth as the caller. Wealth.com can and will rotate the key to match our partners security requirements.

Customer Webhook Configuration Data

Consuming webhooks

When your app receives a webhook request from Wealth.com, check the EventType attribute to see what event caused it. The first part of the event type will tell you the payload type, e.g., a client registration, client accepted invitation, etc.

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "ClientAcceptedInvitation",
  "RegistrationEmail": "john.smith@gmail.com",
  "Timestamp": "2023-04-13T06:43:12.947-07:00"
}

In the example above, a user has accepted invitation to become advisor's client.

Securing Webhooks

Every webhook payload will be accompanied by a wealth-api-key header. Every time a webhook is consumed the header should be validated and match the ApiKey provided by Wealth.com.

Testing

For each webhook type we've provided test curl commands with payloads that you can submit to your webhook handlers to test your implementation.
Please find the test with their corresponding webhook type.