ReferralCreatedEvent
v2

A user that was referred signs up, creating a new entry in the Referral table

Details

ReferralCreatedEvent payload

ReferralCreatedEvent Schema (json)
{
  "$id": "ReferralCreatedEventPayloadTSchema",
  "type": "object",
  "properties": {
    "referral": {
      "type": "object",
      "properties": { "id": { "type": "string" } },
      "required": ["id"]
    },
    "referrerUser": {
      "type": "object",
      "properties": { "id": { "type": "string" } },
      "required": ["id"]
    },
    "referredUser": {
      "type": "object",
      "properties": { "id": { "type": "string" } },
      "required": ["id"]
    },
    "source": {
      "anyOf": [
        { "const": "ENTRAIDE_CHALLENGE", "type": "string" },
        { "const": "ENTRAIDE_HR_FORWARD", "type": "string" }
      ]
    },
    "payload": {
      "anyOf": [
        {
          "$id": "ReferralPayloadDTO",
          "type": "object",
          "properties": {
            "challengeId": { "type": "string" },
            "helpRequestId": { "type": "string" }
          }
        },
        { "type": "null" }
      ]
    }
  },
  "required": ["referral", "referrerUser", "referredUser", "source", "payload"]
}


Edit this pageLast updated on 2024/8/5