UserJoinedMutualHelpEvent
v1

A user joins the Entraide App by completing the onboarding form

Details

UserJoinedMutualHelpEvent payload

UserJoinedMutualHelpEvent Schema (json)
{
  "$id": "UserJoinedMutualHelpEventPayloadTSchema",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "firstName": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
        "lastName": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
        "email": { "type": "string" },
        "availableContexts": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "description": "Easily identify what context (app or service) can be displayed to the user.",
                "anyOf": [
                  { "const": "BACKOFFICE_SPACE", "type": "string" },
                  { "const": "MUTUAL_HELP_SPACE", "type": "string" },
                  { "const": "FEEDBACK_ME_SPACE", "type": "string" },
                  { "const": "TALENT_SPACE", "type": "string" }
                ]
              }
            },
            { "type": "null" }
          ]
        }
      },
      "required": ["id", "email"]
    },
    "mutualHelpProfile": {
      "type": "object",
      "properties": { "id": { "type": "string" } },
      "required": ["id"]
    },
    "referral": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": { "type": "string" },
            "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" }
              ]
            },
            "referrerUser": {
              "type": "object",
              "properties": {
                "id": { "type": "string" },
                "firstName": { "type": "string" }
              },
              "required": ["id", "firstName"]
            }
          },
          "required": ["id", "source", "payload", "referrerUser"]
        },
        { "type": "null" }
      ]
    }
  },
  "required": ["user", "mutualHelpProfile", "referral"]
}


Edit this pageLast updated on 2024/8/5