Client Webhooks

Client webhooks are useful to track or monitor a clients use of wealth.com through logins and feature selections.

Client Accepted Invitation Event

The client accepted invitation event is sent when a client explicitly accepts invitation upon registration.\

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
EventType
Type
string
Description
ClientAcceptedInvitation
Name
AdvisorWid
Type
string (Max 64)
Description
Inviting advisor's Wealth unique identifier.
Name
TeamId
Type
string (Max 64)
Description
Inviting advisor's team unique identifier.
Name
CompanyId
Type
string (Max 64)
Description
Inviting advisor's company unique identifier.
Name
RegistrationEmail
Type
string (Max 320)
Description
Registration email of the client that accepted the invitation.
Name
Timestamp
Type
string
Description
ISO 8601 date time string

Client Accepted Invitation Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "ClientAcceptedInvitation",
  "RegistrationEmail":"john.smaith@gmail.com",
  "Timestamp":"2023-04-13T06:43:12.947-07:00",
  "AdvisorWid":"602cf0b6-129a-47fa-8d42-ba526d5dda49",
  "TeamId":"f2ac8c1a-83f6-4f39-9f83-3bf4d95e5fb3",
  "CompanyId":"64a476f7-be95-4711-b377-12cb895b375f"
}

Client Accepted Invitation Test Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
  -X POST \
  -H "Content-Type: application/json" \
  -H "wealth-api-key: 123456" \
  -d "EventType":"ClientAcceptedInvitation" \
  -d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
  -d "AdvisorWid":"602cf0b6-129a-47fa-8d42-ba526d5dda49" \
  -d "TeamId":"f2ac8c1a-83f6-4f39-9f83-3bf4d95e5fb3" \
  -d "CompanyId":"64a476f7-be95-4711-b377-12cb895b375f" \
  -d "RegistrationEmail":"john.smith@gmail.com" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00"

Client Declined Invitation Event

The client declined invitation event is sent when a user explicitly declines advisor's invitation to become their client.
NOTE: For pre-flight clients it can't be raised because they are already advisor's clients since registration.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the user.
Name
EventType
Type
string
Description
ClientDeclinedInvitation
Name
AdvisorWid
Type
string (Max 64)
Description
Inviting advisor's Wealth unique identifier.
Name
TeamId
Type
string (Max 64)
Description
Inviting advisor's team unique identifier.
Name
RegistrationEmail
Type
string (Max 320)
Description
Registration email of the client that declined the invitation.
Name
Timestamp
Type
string
Description
ISO 8601 date time string

Client Declined Invitation Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "ClientDeclinedInvitation",
  "RegistrationEmail":"john.smaith@gmail.com",
  "AdvisorWid":"602cf0b6-129a-47fa-8d42-ba526d5dda49",
  "TeamId":"f2ac8c1a-83f6-4f39-9f83-3bf4d95e5fb3",
  "CompanyId":"64a476f7-be95-4711-b377-12cb895b375f",
  "Timestamp":"2023-04-13T06:43:12.947-07:00"
}

Client Declined Invitation Test Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
  -X POST \
  -H "Content-Type: application/json" \
  -H "wealth-api-key: 123456" \
  -d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
  -d "EventType":"ClientDeclinedInvitation" \
  -d "RegistrationEmail":"john.smith@gmail.com" \
  -d "AdvisorWid":"602cf0b6-129a-47fa-8d42-ba526d5dda49" \
  -d "TeamId":"f2ac8c1a-83f6-4f39-9f83-3bf4d95e5fb3" \
  -d "CompanyId":"64a476f7-be95-4711-b377-12cb895b375f" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00"

Client Selected Estate Plan Event

The client selected estate plan after registration.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier of the client.
Name
EventType
Type
string
Description
UserSubscriptionCreated
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
NewPlan
Type
string
Description
Code of the plan selected. One of Estate Plan Values

Client Selected Estate Plan Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "UserSubscriptionCreated",
  "Timestamp":"2023-04-13T06:43:12.947-07:00",
  "NewPlan":"individual_will"
}

Client Selected Estate Plan Test Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
  -X POST \
  -H "Content-Type: application/json" \
  -H "wealth-api-key: 123456" \
  -d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
  -d "EventType":"UserSubscriptionCreated" \
  -d "NewPlan":"individual_will" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00"

Client Canceled Estate Plan Event

The client canceled estate plan event is sent when a client cancels their Wealth estate plan.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier of the client.
Name
EventType
Type
string
Description
UserSubscriptionCanceled
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
OldPlan
Type
string
Description
Code of the plan canceled. One of Estate Plan Values

Client Canceled Estate Plan Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "UserSubscriptionCanceled",
  "OldPlan":"couples_trust",
  "Timestamp":"2023-04-13T06:43:12.947-07:00"
}

Client Canceled Estate Plan Test Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
  -X POST \
  -H "Content-Type: application/json" \
  -H "wealth-api-key: 123456" \
  -d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
  -d "EventType":"UserSubscriptionCanceled" \
  -d "OldPlan":"couples_trust" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00"

Client Changed Estate Plan Event

This event is sent when client changes their Wealth estate plan.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier of the client.
Name
EventType
Type
string
Description
UserSubscriptionChanged
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
OldPlan
Type
string
Description
Code of the previous plan. One of Estate Plan Values
Name
NewPlan
Type
string
Description
Code of the new plan. One of Estate Plan Values

Client Changed Estate Plan Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "UserSubscriptionChanged",
  "OldPlan":"individual_will",
  "NewPlan":"joint_will",
  "Timestamp":"2023-04-13T06:43:12.947-07:00"
}

Client Changed Estate Plan Test Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
-X POST \
-H "Content-Type: application/json" \
-H "wealth-api-key: 123456" \
-d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
-d "EventType":"UserSubscriptionChanged" \
-d "OldPlan":"individual_will" \
-d "NewPlan":"joint_will" \
-d "Timestamp":"2023-04-13T06:43:12.947-07:00"

Client Reactivated Estate Plan Event

This event is sent when client reactivates their Wealth estate plan after it was cancelled.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier of the client.
Name
EventType
Type
string
Description
UserSubscriptionReactivated
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
OldPlan
Type
string
Description
Code of the reactivated plan. One of Estate Plan Values

Client Reactivated Estate Plan Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "UserSubscriptionReactivated",
  "OldPlan":"individual_will",
  "Timestamp":"2023-04-13T06:43:12.947-07:00"
}

Client Changed Estate Plan Test Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
-X POST \
-H "Content-Type: application/json" \
-H "wealth-api-key: 123456" \
-d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
-d "EventType":"UserSubscriptionReactivated" \
-d "OldPlan":"individual_will" \
-d "Timestamp":"2023-04-13T06:43:12.947-07:00"

Client Progress Changed Event

The client progress changed event is sent when a client’s progress towards completing their estate plan changes.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
EventType
Type
string
Description
ClientProgressChanged
Name
EstateStatus
Type
string
Description
One of Estate Status Values
Name
CompletionPercentage
Type
Integer
Description
Overall client progress measured as a percentage. [0-100]
Name
Timestamp
Type
string
Description
ISO 8601 date time string

Client Progress Changed Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "ClientProgressChanged",
  "EstateStatus":"InProgress",
  "CompletionPercentage":30,
  "Timestamp":"2023-04-13T06:43:12.947-07:00"
}

Client Progress Changed Test Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
-X POST \
-H "Content-Type: application/json" \
-H "wealth-api-key: 123456" \
-d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
-d "EventType":"ClientProgressChanged" \
-d "EstateStatus":"InProgress" \
-d "CompletionPercentage":"30" \
-d "Timestamp":"2023-04-13T06:43:12.947-07:00"

Estate Status Values

List of estate Status values.

Status	Description
NotStarted	Client don't have any documents started. Note: this will be raised only if client started the process of filling document and then discarded the changes.
InProgress	Client has at least one document in progress.
PendingValidation	All client documents are completed or pending validation.
Completed	All client documents are completed.