> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.redpincompany.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.redpincompany.com/_mcp/server.

# Referral Created Event

POST 

Sent when a referral is created successfully or when referral creation fails.
This webhook helps you track the status of your referrals in real-time.


Reference: https://docs.redpincompany.com/api-reference/webhooks/referrals/webhook-referral-created

## Request

### Payload

- `partner_id` (string, required) — Partner ID of the partner referring the customer (not required unless using multiple partner accounts)
- `referral_id` (string, required) — Unique identifier for the referral
- `status` (string, required) — Status of the referral
- `event_name` (string, required) — Event name
- `customer_id` (string, optional) — Unique Customer Id generated post registration
- `failure_message` (string, optional) — Failure message to be returned in case status - FAILED
- `referral_date` (datetime, optional)
- `registration_date` (datetime, optional)
- `first_trade_date` (datetime, optional)
- `additional_details` (ReferralCreatedEventAdditionalDetails, optional) — Additional details about the referral's requirements
- `company` (ReferralCreatedEventCompany, optional) — Company details (required if customer_type is Corporate)
- `contact` (ReferralCreatedEventContact, optional) — Contact details for the referral

## Types

### ReferralCreatedEventAdditionalDetails

Additional details about the referral's requirements

- `client_reference_id` (string, optional) — Partner's internal reference ID for this referral
- `enquiry_notes` (string, optional) — Field to contain any additional information which might help the Redpin onboarding team
- `service_required` (enum, optional) — Type of service the referral is interested in
  - Allowed values: `Property Purchase`, `Property Sale`, `Regular Payments`, `Other`
- `country_moving_to` (string, optional) — Destination country if the referral is relocating
- `ccy_pair` (string, optional) — Currency pair for the transaction (e.g., GBPEUR)
- `etv` (enum, optional) — Estimated transaction value range
  - Allowed values: `Under 2,000`, `2,000 - 5,000`, `2,000 - 10,000`, `5,000 - 10,000`, `10,000 - 25,000`, `25,000 - 50,000`, `50,000 - 100,000`, `100,000 - 250,000`, `Over 250,000`

### ReferralCreatedEventCompany

Company details (required if customer_type is Corporate)

- `name` (string, optional) — Company name
- `registration_number` (string, optional) — Company registration number
- `required` (any, optional)

### ReferralCreatedEventContact

Contact details for the referral

- `last_name` (string, required) — Last name of the contact
- `email` (string, required) — Email address of the contact
- `phone_number` (string, required) — Main phone number including country code
- `first_name` (string, optional) — First name of the contact
- `date_of_birth` (date, optional) — Date of birth in ISO 8601 format (YYYY-MM-DD)
- `mobile_number` (string, optional) — Mobile phone number including country code
- `address` (ReferralCreatedEventContactAddress, optional)

### ReferralCreatedEventContactAddress

- `street` (string, required) — Street address
- `city` (string, required) — City
- `country` (string, required) — Country name
- `state` (string, optional) — State, province, or region
- `post_code` (string, optional) — Postal code