Communication

Below is a reference to the Endgrate types supported for communication integrations, and their corresponding default schemas.

communication-meeting

Schema:

{
  "host_email": {
    "items": {
      "properties": {
        "email_address": {
          "format": "email",
          "title": "Email Address",
          "type": "string"
        },
        "email_type": {
          "enum": [
            "WORK",
            "PERSONAL",
            "OTHER"
          ],
          "title": "Email Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Host Email",
    "type": "array"
  },
  "duration": {
    "title": "Duration",
    "description": "Meeting duration in minutes.",
    "type": "number"
  },
  "start": {
    "title": "Start",
    "description": "The start time of the meeting.",
    "type": "string",
    "format": "date-time"
  },
  "end": {
    "title": "End",
    "description": "The end time of the meeting.",
    "type": "string",
    "format": "date-time"
  },
  "topic": {
    "title": "Topic",
    "description": "The meeting's topic.",
    "type": "string"
  },
  "participants_count": {
    "title": "Participants Count",
    "description": "The number of participants in the meeting.",
    "type": "number"
  },
  "participants": {
    "title": "Participants",
    "description": "Participants info.",
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "name": {
          "title": "Name",
          "description": "The participant's display name.",
          "type": "string"
        },
        "email": {
          "items": {
            "properties": {
              "email_address": {
                "format": "email",
                "title": "Email Address",
                "type": "string"
              },
              "email_type": {
                "enum": [
                  "WORK",
                  "PERSONAL",
                  "OTHER"
                ],
                "title": "Email Type",
                "type": "string"
              }
            },
            "type": "object"
          },
          "title": "Participant Email",
          "description": "The Participant's email.",
          "type": "array"
        }
      }
    }
  }
}

communication-message_history

Schema:

{
  "timestamp": {
    "title": "Timestamp",
    "type": "string",
    "format": "date-time"
  },
  "name": {
    "title": "Name",
    "type": "string"
  },
  "unread_count": {
    "title": "Unread Count",
    "type": "number"
  },
  "archived": {
    "title": "Archived",
    "type": "boolean"
  },
  "muted_until": {
    "title": "Muted Until",
    "type": "string",
    "format": "date-time"
  },
  "read_only": {
    "title": "Read Only",
    "type": "boolean"
  },
  "messages": {
    "title": "Messages",
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "text": {
          "title": "Text",
          "description": "The text of the message.",
          "type": "string"
        },
        "timestamp": {
          "title": "Timestamp",
          "type": "string",
          "format": "date-time"
        },
        "behavior": {
          "type": "string"
        },
        "seen": {
          "type": "boolean"
        },
        "edited": {
          "type": "boolean"
        },
        "hidden": {
          "type": "boolean"
        },
        "deleted": {
          "type": "boolean"
        },
        "is_event": {
          "type": "boolean"
        },
        "delivered": {
          "type": "boolean"
        },
        "is_sender": {
          "type": "boolean"
        }
      }
    }
  },
  "attendees": {
    "title": "Attendees",
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "is_self": {
          "type": "boolean"
        },
        "name": {
          "title": "Attendee Name",
          "type": "string"
        },
        "picture_url": {
          "type": "string",
          "format": "uri"
        },
        "profile_url": {
          "type": "string",
          "format": "uri"
        }
      }
    }
  }
}

communication-user

{
  "email_addresses": {
    "items": {
      "properties": {
        "email_address": {
          "format": "email",
          "title": "Email Address",
          "type": "string"
        },
        "email_type": {
          "enum": [
            "WORK",
            "PERSONAL",
            "OTHER"
          ],
          "title": "Email Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Email Addresses",
    "type": "array"
  },
  "first_name": {
    "title": "First Name",
    "type": "string"
  },
  "is_active": {
    "title": "Active",
    "type": "boolean"
  },
  "last_name": {
    "title": "Last Name",
    "type": "string"
  }
}

Example Object:

{
  "email_addresses": [
    {
      "email_address": "[email protected]",
      "email_type": "WORK"
    }
  ],
  "first_name": "John",
  "is_active": true,
  "last_name": "Doe"
}