Skip to main content

Add Payment Info Using Link

The ADD_PAYMENT_INFO_USING_LINK event is triggered patient added their payment info via payment setup link.

Attributes​

eventstring
The name of the event that was triggered. For this webhook, the value will always be ADD_PAYMENT_INFO_USING_LINK.
payloadobject
Contains all the data associated with the payment information addition event.
Show child attributes
activityobject
Details of the activity that occurred when payment info was added.
Show child attributes
idstring<UUID>
The unique identifier of the activity record.
typestring
Specifies the type of the activity, here it will always be ADD_PAYMENT_INFO_USING_LINK.
isPHIboolean
Indicates whether the activity involves Protected Health Information (PHI).
isRestrictedboolean
Indicates whether the activity details are restricted or confidential.
timestampstring<ISO8601 DateTime>
The exact date and time when the payment information was added.
valueBeforestring | null
The previous state or value before the payment information was added (null if none).
valueAfterstring
A description or message indicating the result of the event (e.g., 'payment info has been added').
actorobject
Details of the user who performed the action (added payment information).
Show child attributes
idstring<UUID>
The unique identifier of the user who performed the action.
firstNamestring
The first name of the actor.
lastNamestring
The last name of the actor.
emailstring<email>
The email address of the actor.
targetUserobject
Details of the user whose payment information was updated.
Show child attributes
idstring<UUID>
The unique identifier of the target user.
firstNamestring
The first name of the target user.
lastNamestring
The last name of the target user.
emailstring<email>
The email address of the target user.
caseIdstring<UUID>
The unique identifier of the case associated with the payment information update.

Response​

{
  "event": "ADD_PAYMENT_INFO_USING_LINK",
  "payload": {
    "activity": {
      "id": "e02120ac-54d7-406e-939f-a734475f4105",
      "type": "ADD_PAYMENT_INFO_USING_LINK",
      "isPHI": false,
      "isRestricted": true,
      "timestamp": "2025-11-07T22:04:19.702Z",
      "valueBefore": null,
      "valueAfter": "payment info has been added",
      "actor": {
        "id": "j0etUrcaTaQFoOPmi8ZGuwwZk9s1",
        "firstName": "Ritik-3",
        "lastName": "Parikh-3",
        "email": "ritik.parikh+03@carevalidate.com"
      },
      "targetUser": {
        "id": "j0etUrcaTaQFoOPmi8ZGuwwZk9s1",
        "firstName": "Ritik-3",
        "lastName": "Parikh-3",
        "email": "ritik.parikh+03@carevalidate.com"
      }
    },
    "caseId": "000de576-8844-4d42-abba-a235d741e323"
  }
}