HelpRequestMatchedEvent
v1

A HelpRequest is matched within a HelpRequestSelection

Details

HelpRequestMatchedEvent payload

HelpRequestMatchedEvent Schema (json)
{
  "$id": "HelpRequestMatchedEventPayloadTSchema",
  "type": "object",
  "properties": {
    "helpRequest": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "matchedAt": {
          "anyOf": [
            { "format": "datetime", "type": "string" },
            { "type": "null" }
          ]
        },
        "status": {
          "anyOf": [
            { "const": "PENDING_FOR_VALIDATION", "type": "string" },
            { "const": "PENDING_FOR_MATCHING", "type": "string" },
            { "const": "REJECTED", "type": "string" },
            { "const": "MATCHED", "type": "string" },
            { "const": "EXPIRED", "type": "string" }
          ]
        }
      },
      "required": ["id", "status"]
    },
    "helpRequestSelection": {
      "type": "object",
      "properties": { "id": { "type": "string" } },
      "required": ["id"]
    },
    "helpedUser": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "firstName": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
        "email": { "type": "string" }
      },
      "required": ["id", "email"]
    }
  },
  "required": ["helpRequest", "helpRequestSelection", "helpedUser"]
}


Edit this pageLast updated on 2024/8/5