organization member_invited event

APIs.ioEngineeringPlatform

Properties

Name Type Description
action string
enterprise object
installation object
invitation object The invitation for the user or email if the action is `member_invited`.
organization object
repository object
sender object
user object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-webhook-organization-member-invited-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhook-organization-member-invited",
  "title": "organization member_invited event",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "member_invited"
      ]
    },
    "enterprise": {
      "$ref": "#/components/schemas/enterprise-webhooks"
    },
    "installation": {
      "$ref": "#/components/schemas/simple-installation"
    },
    "invitation": {
      "description": "The invitation for the user or email if the action is `member_invited`.",
      "type": "object",
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "email": {
          "type": "string",
          "nullable": true
        },
        "failed_at": {
          "type": "string",
          "nullable": true,
          "format": "date-time"
        },
        "failed_reason": {
          "type": "string",
          "nullable": true
        },
        "id": {
          "type": "number"
        },
        "invitation_teams_url": {
          "type": "string",
          "format": "uri"
        },
        "inviter": {
          "title": "User",
          "type": "object",
          "nullable": true,
          "properties": {
            "avatar_url": {
              "type": "string",
              "format": "uri"
            },
            "deleted": {
              "type": "boolean"
            },
            "email": {
              "type": "string",
              "nullable": true
            },
            "events_url": {
              "type": "string",
              "format": "uri-template"
            },
            "followers_url": {
              "type": "string",
              "format": "uri"
            },
            "following_url": {
              "type": "string",
              "format": "uri-template"
            },
            "gists_url": {
              "type": "string",
              "format": "uri-template"
            },
            "gravatar_id": {
              "type": "string"
            },
            "html_url": {
              "type": "string",
              "format": "uri"
            },
            "id": {
              "type": "integer"
            },
            "login": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "node_id": {
              "type": "string"
            },
            "organizations_url": {
              "type": "string",
              "format": "uri"
            },
            "received_events_url": {
              "type": "string",
              "format": "uri"
            },
            "repos_url": {
              "type": "string",
              "format": "uri"
            },
            "site_admin": {
              "type": "boolean"
            },
            "starred_url": {
              "type": "string",
              "format": "uri-template"
            },
            "subscriptions_url": {
              "type": "string",
              "format": "uri"
            },
            "type": {
              "type": "string",
              "enum": [
                "Bot",
                "User",
                "Organization"
              ]
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          },
          "required": [
            "login",
            "id"
          ]
        },
        "login": {
          "type": "string",
          "nullable": true
        },
        "node_id": {
          "type": "string"
        },
        "role": {
          "type": "string"
        },
        "team_count": {
          "type": "number"
        },
        "invitation_source": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "node_id",
        "login",
        "email",
        "role",
        "created_at",
        "failed_at",
        "failed_reason",
        "inviter",
        "team_count",
        "invitation_teams_url"
      ]
    },
    "organization": {
      "$ref": "#/components/schemas/organization-simple-webhooks"
    },
    "repository": {
      "$ref": "#/components/schemas/repository-webhooks"
    },
    "sender": {
      "$ref": "#/components/schemas/simple-user-webhooks"
    },
    "user": {
      "$ref": "#/components/schemas/webhooks_user"
    }
  },
  "required": [
    "action",
    "invitation",
    "organization",
    "sender"
  ]
}