---
title: Referral Scores
slug: referral-scores
docTags: 
createdAt: 2025-08-14T14:51:50.038Z
---

Webhook to receive Referral Scores objects, whenever the score of a referrer is updated.

**Actions**

| Name    | Description           |
| ------- | --------------------- |
| updated | The score was updated |

**Request Payload**

| Name            | Type   | Description                             |
| --------------- | ------ | --------------------------------------- |
| action          | string | Action triggering the event (see above) |
| referrer\_score | object | The referrer\_score object              |
| event\_type     | string | "referral\_scores"                      |

### Referrer Score Object

| Name     | Type    | Description                         |
| -------- | ------- | ----------------------------------- |
| referral | object  | Referral details object             |
| referrer | object  | Referrer details object             |
| score    | integer | Updated total score of the Referrer |

### Referral Object

| Name        | Type    | Description                |
| ----------- | ------- | -------------------------- |
| id          | integer | ID of the Referral         |
| first\_name | string  | First name of the Referral |
| last\_name  | string  | Last name of the Referral  |
| email       | email   | Email of the Referral      |

### Referrer Object

| Name        | Type   | Description                |
| ----------- | ------ | -------------------------- |
| first\_name | string | First name of the Referrer |
| last\_name  | string | Last name of the Referrer  |
| email       | email  | Email of the Referrer      |