matrix-spec/data/api/server-server/definitions/invite_event.yaml

# Copyright 2018-2019 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
type: object
title: InviteEvent
description: |-
  An invite event. Note that events have a different format depending on the
  room version - check the [room version specification](/rooms) for precise event formats.
allOf:
  - type: object
    properties:
      sender:
        type: string
        description: |-
          The matrix ID of the user who sent the original `m.room.third_party_invite`.
        example: "@someone:example.org"
      origin:
        type: string
        description: The name of the inviting homeserver.
        example: "matrix.org"
      origin_server_ts:
        type: integer
        format: int64
        description: A timestamp added by the inviting homeserver.
        example: 1234567890
      type:
        type: string
        description: The value `m.room.member`.
        example: "m.room.member"
      state_key:
        type: string
        description: The user ID of the invited member.
        example: "@joe:elsewhere.com"
      content:
        type: object
        title: Membership Event Content
        description: |-
          The content of the event, matching what is available in the
          [Client-Server API](/client-server-api/). Must include a `membership` of `invite`.
        example: {"membership": "invite"}
        properties:
          membership:
            type: string
            description: The value `invite`.
            example: "invite"
        required: ['membership']
    required:
      - state_key
      - sender
      - origin
      - origin_server_ts
      - type
      - content