Invite Recipients
invite_recipient.added
A recipient is added to an invite, such as through POST /v1/invites/{id}/invite-recipients.
WEBHOOK
invite_recipient.added
{
"event_id": "7a4e9c12-3b6d-4e85-a1f7-9d2c5b8e0f46",
"event_type": "invite_recipient.added",
"occurred_at": "2025-07-28T18:27:54.690Z",
"data": {
"invite_id": "inv_8f3k2jd9slq02mxp",
"application_id": null,
"invite_recipient": {
"id": "ivre_vd5t9qdhbhdx4iei",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/vd5t9qdhbhdx4iei",
"first_name": "Jordan",
"last_name": "Lee",
"email": "jordan.lee@example.com",
"phone_number": "+12125551236",
"metadata": {
"pms_reference": "occupant-2"
},
"object": "invite_recipient"
}
}
}Body
application/json
Identifier of the event that triggered this webhook. It stays the same when a delivery is retried, so you can use it to deduplicate. Treat it as an opaque string; its format varies by event type.
Denotes the resource and what happened to it.
UTC timestamp when the source event occurred.
Example:
"2025-07-28T18:27:54.690Z"
Show child attributes
Show child attributes
Response
200
Your endpoint should return 2xx
⌘I
{
"event_id": "7a4e9c12-3b6d-4e85-a1f7-9d2c5b8e0f46",
"event_type": "invite_recipient.added",
"occurred_at": "2025-07-28T18:27:54.690Z",
"data": {
"invite_id": "inv_8f3k2jd9slq02mxp",
"application_id": null,
"invite_recipient": {
"id": "ivre_vd5t9qdhbhdx4iei",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/vd5t9qdhbhdx4iei",
"first_name": "Jordan",
"last_name": "Lee",
"email": "jordan.lee@example.com",
"phone_number": "+12125551236",
"metadata": {
"pms_reference": "occupant-2"
},
"object": "invite_recipient"
}
}
}