Event object

This reference details the structure of each event object and explains how to interpret the data in your application.

​

New recipient created

This event is triggered whenever an end-user adds a new recipient. Use this event to capture and store new beneficiary details in your system.

• type: RECIPIENT.CREATED

{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "c6fd6330-6932-4678-abf8-600fe155909c"
}

​

Recipient updated

This event is triggered whenever an end-user makes any update to a recipient, including but not limited to switching the default recipient. Use this event to ensure your system remains in sync with the latest recipient information, particularly updating the “default” status when a new recipient is set as the preferred option.

• type: RECIPIENT.UPDATED

{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "d937f855-de7a-49dc-99ca-7d5f9f1f39e2"
}

​

Recipient deleted

This event is triggered whenever an end-user deletes an existing recipient. Use this event to remove any records associated with the recipient from your system.

• type: RECIPIENT.DELETED

{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "a70ea3bb-c677-4af5-9ee3-ff11f96cb433"
}