Amigo · Schema

WorkspaceSSEEvent

CompanyArtificial IntelligenceHealthcareAI AgentsVoiceClinicalConversational AIFHIRElectronic Health RecordsHIPAA
View JSON Schema on GitHub

JSON Schema

amigo-workspace-sseevent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amigo/main/json-schema/amigo-workspace-sseevent-schema.json",
  "title": "WorkspaceSSEEvent",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amigo-events-api-openapi.yml#/components/schemas/WorkspaceSSEEvent",
  "oneOf": [
    {
      "$ref": "#/$defs/CallStartedEvent"
    },
    {
      "$ref": "#/$defs/CallEndedEvent"
    },
    {
      "$ref": "#/$defs/CallEscalatedEvent"
    },
    {
      "$ref": "#/$defs/EncounterUpdatedEvent"
    },
    {
      "$ref": "#/$defs/NarrativeUpdatedEvent"
    },
    {
      "$ref": "#/$defs/ReviewSubmittedEvent"
    },
    {
      "$ref": "#/$defs/SimulationTurnStoredEvent"
    },
    {
      "$ref": "#/$defs/SurfaceCreatedEvent"
    },
    {
      "$ref": "#/$defs/SurfaceDeliveredEvent"
    },
    {
      "$ref": "#/$defs/SurfaceUpdatedEvent"
    },
    {
      "$ref": "#/$defs/SurfaceArchivedEvent"
    },
    {
      "$ref": "#/$defs/SurfaceReshapedEvent"
    },
    {
      "$ref": "#/$defs/SurfaceSubmittedEvent"
    },
    {
      "$ref": "#/$defs/SurfaceFieldSavedEvent"
    },
    {
      "$ref": "#/$defs/SurfaceOpenedEvent"
    },
    {
      "$ref": "#/$defs/SurfacePendingReviewEvent"
    },
    {
      "$ref": "#/$defs/SurfaceReviewApprovedEvent"
    },
    {
      "$ref": "#/$defs/SurfaceReviewRejectedEvent"
    },
    {
      "$ref": "#/$defs/IntegrationApprovalGrantedEvent"
    },
    {
      "$ref": "#/$defs/IntegrationApprovalRejectedEvent"
    },
    {
      "$ref": "#/$defs/TextStartedEvent"
    },
    {
      "$ref": "#/$defs/TextCompletedEvent"
    },
    {
      "$ref": "#/$defs/TextToolStartedEvent"
    },
    {
      "$ref": "#/$defs/TextBackgroundResultEvent"
    },
    {
      "$ref": "#/$defs/TextAgentMessageEvent"
    },
    {
      "$ref": "#/$defs/TriggerFiredEvent"
    },
    {
      "$ref": "#/$defs/TriggerCompletedEvent"
    },
    {
      "$ref": "#/$defs/TriggerFailedEvent"
    },
    {
      "$ref": "#/$defs/PipelineSyncCompletedEvent"
    },
    {
      "$ref": "#/$defs/PipelineErrorEvent"
    },
    {
      "$ref": "#/$defs/OperatorRegisteredEvent"
    },
    {
      "$ref": "#/$defs/OperatorStatusChangedEvent"
    },
    {
      "$ref": "#/$defs/OperatorProfileUpdatedEvent"
    },
    {
      "$ref": "#/$defs/OperatorJoinedCallEvent"
    },
    {
      "$ref": "#/$defs/OperatorLeftCallEvent"
    },
    {
      "$ref": "#/$defs/OperatorModeChangedEvent"
    },
    {
      "$ref": "#/$defs/OperatorWrapUpEvent"
    },
    {
      "$ref": "#/$defs/WorkspaceMemberAddedEvent"
    },
    {
      "$ref": "#/$defs/WorkspaceMemberRoleUpdatedEvent"
    },
    {
      "$ref": "#/$defs/WorkspaceInvitationSentEvent"
    },
    {
      "$ref": "#/$defs/WorkspaceInvitationAcceptedEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailDeliveredEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailBouncedEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailComplainedEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailRejectedEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailDelayedEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailOpenedEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailClickedEvent"
    },
    {
      "$ref": "#/$defs/ChannelEmailReceivedEvent"
    },
    {
      "$ref": "#/$defs/ChannelVoicemailStatusEvent"
    }
  ],
  "$defs": {
    "CallEndedEvent": {
      "properties": {
        "event_type": {
          "const": "call.ended",
          "default": "call.ended",
          "title": "Event Type",
          "type": "string"
        },
        "call_sid": {
          "title": "Call Sid",
          "type": "string"
        },
        "direction": {
          "enum": [
            "inbound",
            "outbound",
            "playground",
            "simulated",
            "test"
          ],
          "title": "Direction",
          "type": "string"
        },
        "duration_seconds": {
          "title": "Duration Seconds",
          "type": "number"
        },
        "completion_reason": {
          "enum": [
            "completed",
            "abandoned",
            "escalated",
            "transferred",
            "timeout",
            "error",
            "voicemail",
            "no_answer",
            "caller_hangup",
            "forwarded",
            "terminal_state",
            "warm_transfer_completed",
            "no_inbound_audio",
            "cancelled"
          ],
          "title": "Completion Reason",
          "type": "string"
        },
        "escalated": {
          "default": false,
          "title": "Escalated",
          "type": "boolean"
        }
      },
      "required": [
        "call_sid",
        "direction",
        "duration_seconds",
        "completion_reason"
      ],
      "title": "CallEndedEvent",
      "type": "object"
    },
    "CallEscalatedEvent": {
      "properties": {
        "event_type": {
          "const": "call.escalated",
          "default": "call.escalated",
          "title": "Event Type",
          "type": "string"
        },
        "call_sid": {
          "title": "Call Sid",
          "type": "string"
        },
        "escalation_id": {
          "title": "Escalation Id",
          "type": "string"
        },
        "trigger": {
          "enum": [
            "caller",
            "ai",
            "operator"
          ],
          "title": "Trigger",
          "type": "string"
        },
        "reason": {
          "title": "Reason",
          "type": "string"
        }
      },
      "required": [
        "call_sid",
        "escalation_id",
        "trigger",
        "reason"
      ],
      "title": "CallEscalatedEvent",
      "type": "object"
    },
    "CallStartedEvent": {
      "properties": {
        "event_type": {
          "const": "call.started",
          "default": "call.started",
          "title": "Event Type",
          "type": "string"
        },
        "call_sid": {
          "title": "Call Sid",
          "type": "string"
        },
        "direction": {
          "enum": [
            "inbound",
            "outbound",
            "playground",
            "simulated",
            "test"
          ],
          "title": "Direction",
          "type": "string"
        },
        "service_id": {
          "format": "uuid",
          "title": "Service Id",
          "type": "string"
        },
        "caller_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Caller Id",
          "x-phi": true
        }
      },
      "required": [
        "call_sid",
        "direction",
        "service_id"
      ],
      "title": "CallStartedEvent",
      "type": "object"
    },
    "ChannelEmailBouncedEvent": {
      "properties": {
        "event_type": {
          "const": "channel.email_bounced",
          "default": "channel.email_bounced",
          "title": "Event Type",
          "type": "string"
        },
        "email_id": {
          "title": "Email Id",
          "type": "string"
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        },
        "from_address": {
          "title": "From Address",
          "type": "string"
        },
        "bounce_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Bounce Type"
        },
        "bounce_subtype": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Bounce Subtype"
        }
      },
      "required": [
        "email_id",
        "to_address",
        "from_address"
      ],
      "title": "ChannelEmailBouncedEvent",
      "type": "object"
    },
    "ChannelEmailClickedEvent": {
      "properties": {
        "event_type": {
          "const": "channel.email_clicked",
          "default": "channel.email_clicked",
          "title": "Event Type",
          "type": "string"
        },
        "email_id": {
          "title": "Email Id",
          "type": "string"
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        }
      },
      "required": [
        "email_id",
        "to_address"
      ],
      "title": "ChannelEmailClickedEvent",
      "type": "object"
    },
    "ChannelEmailComplainedEvent": {
      "properties": {
        "event_type": {
          "const": "channel.email_complained",
          "default": "channel.email_complained",
          "title": "Event Type",
          "type": "string"
        },
        "email_id": {
          "title": "Email Id",
          "type": "string"
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        },
        "from_address": {
          "title": "From Address",
          "type": "string"
        }
      },
      "required": [
        "email_id",
        "to_address",
        "from_address"
      ],
      "title": "ChannelEmailComplainedEvent",
      "type": "object"
    },
    "ChannelEmailDelayedEvent": {
      "properties": {
        "event_type": {
          "const": "channel.email_delayed",
          "default": "channel.email_delayed",
          "title": "Event Type",
          "type": "string"
        },
        "email_id": {
          "title": "Email Id",
          "type": "string"
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        },
        "from_address": {
          "title": "From Address",
          "type": "string"
        }
      },
      "required": [
        "email_id",
        "to_address",
        "from_address"
      ],
      "title": "ChannelEmailDelayedEvent",
      "type": "object"
    },
    "ChannelEmailDeliveredEvent": {
      "properties": {
        "event_type": {
          "const": "channel.email_delivered",
          "default": "channel.email_delivered",
          "title": "Event Type",
          "type": "string"
        },
        "email_id": {
          "title": "Email Id",
          "type": "string"
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        },
        "from_address": {
          "title": "From Address",
          "type": "string"
        }
      },
      "required": [
        "email_id",
        "to_address",
        "from_address"
      ],
      "title": "ChannelEmailDeliveredEvent",
      "type": "object"
    },
    "ChannelEmailOpenedEvent": {
      "properties": {
        "event_type": {
          "const": "channel.email_opened",
          "default": "channel.email_opened",
          "title": "Event Type",
          "type": "string"
        },
        "email_id": {
          "title": "Email Id",
          "type": "string"
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        }
      },
      "required": [
        "email_id",
        "to_address"
      ],
      "title": "ChannelEmailOpenedEvent",
      "type": "object"
    },
    "ChannelEmailReceivedEvent": {
      "description": "Inbound email persisted to channel.inbound_emails as a reply to one of\nour outbound sends. ``in_reply_to_email_id`` is the outbound row this\ninbound threads against.",
      "properties": {
        "event_type": {
          "const": "channel.email_received",
          "default": "channel.email_received",
          "title": "Event Type",
          "type": "string"
        },
        "inbound_email_id": {
          "title": "Inbound Email Id",
          "type": "string"
        },
        "in_reply_to_email_id": {
          "title": "In Reply To Email Id",
          "type": "string"
        },
        "from_address": {
          "title": "From Address",
          "type": "string",
          "x-phi": true
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        },
        "subject": {
          "title": "Subject",
          "type": "string"
        }
      },
      "required": [
        "inbound_email_id",
        "in_reply_to_email_id",
        "from_address",
        "to_address",
        "subject"
      ],
      "title": "ChannelEmailReceivedEvent",
      "type": "object"
    },
    "ChannelEmailRejectedEvent": {
      "properties": {
        "event_type": {
          "const": "channel.email_rejected",
          "default": "channel.email_rejected",
          "title": "Event Type",
          "type": "string"
        },
        "email_id": {
          "title": "Email Id",
          "type": "string"
        },
        "to_address": {
          "title": "To Address",
          "type": "string",
          "x-phi": true
        },
        "from_address": {
          "title": "From Address",
          "type": "string"
        }
      },
      "required": [
        "email_id",
        "to_address",
        "from_address"
      ],
      "title": "ChannelEmailRejectedEvent",
      "type": "object"
    },
    "ChannelVoicemailStatusEvent": {
      "description": "Ringless voicemail status callback projected from VoiceDrop. ``status``\nmirrors the channel.voicedrop_ringless_voicemails enum: delivered,\nskipped, failed, or not_delivered (pending is the row's initial state and\nis never emitted as an event).",
      "properties": {
        "event_type": {
          "const": "channel.voicemail_status",
          "default": "channel.voicemail_status",
          "title": "Event Type",
          "type": "string"
        },
        "voicemail_id": {
          "format": "uuid",
          "title": "Voicemail Id",
          "type": "string"
        },
        "status": {
          "enum": [
            "delivered",
            "skipped",
            "failed",
            "not_delivered"
          ],
          "title": "Status",
          "type": "string"
        },
        "recipient_phone_number": {
          "title": "Recipient Phone Number",
          "type": "string",
          "x-phi": true
        }
      },
      "required": [
        "voicemail_id",
        "status",
        "recipient_phone_number"
      ],
      "title": "ChannelVoicemailStatusEvent",
      "type": "object"
    },
    "EncounterUpdatedEvent": {
      "properties": {
        "event_type": {
          "const": "encounter.updated",
          "default": "encounter.updated",
          "title": "Event Type",
          "type": "string"
        },
        "encounter_entity_id": {
          "format": "uuid",
          "title": "Encounter Entity Id",
          "type": "string"
        },
        "session_id": {
          "title": "Session Id",
          "type": "string"
        }
      },
      "required": [
        "encounter_entity_id",
        "session_id"
      ],
      "title": "EncounterUpdatedEvent",
      "type": "object"
    },
    "IntegrationApprovalGrantedEvent": {
      "properties": {
        "event_type": {
          "const": "integration.approval_granted",
          "default": "integration.approval_granted",
          "title": "Event Type",
          "type": "string"
        },
        "conversation_id": {
          "maxLength": 256,
          "minLength": 1,
          "title": "Conversation Id",
          "type": "string"
        }
      },
      "required": [
        "conversation_id"
      ],
      "title": "IntegrationApprovalGrantedEvent",
      "type": "object"
    },
    "IntegrationApprovalRejectedEvent": {
      "properties": {
        "event_type": {
          "const": "integration.approval_rejected",
          "default": "integration.approval_rejected",
          "title": "Event Type",
          "type": "string"
        },
        "conversation_id": {
          "maxLength": 256,
          "minLength": 1,
          "title": "Conversation Id",
          "type": "string"
        },
        "reason": {
          "anyOf": [
            {
              "maxLength": 2000,
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reason"
        }
      },
      "required": [
        "conversation_id"
      ],
      "title": "IntegrationApprovalRejectedEvent",
      "type": "object"
    },
    "NarrativeUpdatedEvent": {
      "properties": {
        "event_type": {
          "const": "self_image.brief_generated",
          "default": "self_image.brief_generated",
          "title": "Event Type",
          "type": "string"
        },
        "target_entity_id": {
          "format": "uuid",
          "title": "Target Entity Id",
          "type": "string"
        },
        "target_entity_type": {
          "title": "Target Entity Type",
          "type": "string"
        },
        "event_id": {
          "format": "uuid",
          "title": "Event Id",
          "type": "string"
        },
        "version": {
          "title": "Version",
          "type": "string"
        },
        "confidence": {
          "title": "Confidence",
          "type": "number"
        },
        "event_count": {
          "title": "Event Count",
          "type": "integer"
        }
      },
      "required": [
        "target_entity_id",
        "target_entity_type",
        "event_id",
        "version",
        "confidence",
        "event_count"
      ],
      "title": "NarrativeUpdatedEvent",
      "type": "object"
    },
    "OperatorJoinedCallEvent": {
      "properties": {
        "event_type": {
          "const": "operator.joined_call",
          "default": "operator.joined_call",
          "title": "Event Type",
          "type": "string"
        },
        "call_sid": {
          "title": "Call Sid",
          "type": "string"
        },
        "operator_id": {
          "format": "uuid",
          "title": "Operator Id",
          "type": "string"
        },
        "mode": {
          "enum": [
            "listen",
            "takeover"
          ],
          "title": "Mode",
          "type": "string"
        }
      },
      "required": [
        "call_sid",
        "operator_id",
        "mode"
      ],
      "title": "OperatorJoinedCallEvent",
      "type": "object"
    },
    "OperatorLeftCallEvent": {
      "properties": {
        "event_type": {
          "const": "operator.left_call",
          "default": "operator.left_call",
          "title": "Event Type",
          "type": "string"
        },
        "call_sid": {
          "title": "Call Sid",
          "type": "string"
        },
        "operator_id": {
          "format": "uuid",
          "title": "Operator Id",
          "type": "string"
        },
        "human_segment_turn_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Human Segment Turn Count"
        }
      },
      "required": [
        "call_sid",
        "operator_id"
      ],
      "title": "OperatorLeftCallEvent",
      "type": "object"
    },
    "OperatorModeChangedEvent": {
      "properties": {
        "event_type": {
          "const": "operator.mode_changed",
          "default": "operator.mode_changed",
          "title": "Event Type",
          "type": "string"
        },
        "call_sid": {
          "title": "Call Sid",
          "type": "string"
        },
        "operator_id": {
          "format": "uuid",
          "title": "Operator Id",
          "type": "string"
        },
        "mode": {
          "enum": [
            "listen",
            "takeover"
          ],
          "title": "Mode",
          "type": "string"
        }
      },
      "required": [
        "call_sid",
        "operator_id",
        "mode"
      ],
      "title": "OperatorModeChangedEvent",
      "type": "object"
    },
    "OperatorProfileUpdatedEvent": {
      "properties": {
        "event_type": {
          "const": "operator.profile_updated",
          "default": "operator.profile_updated",
          "title": "Event Type",
          "type": "string"
        },
        "operator_id": {
          "format": "uuid",
          "title": "Operator Id",
          "type": "string"
        },
        "changes": {
          "anyOf": [
            {
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Changes"
        }
      },
      "required": [
        "operator_id"
      ],
      "title": "OperatorProfileUpdatedEvent",
      "type": "object"
    },
    "OperatorRegisteredEvent": {
      "properties": {
        "event_type": {
          "const": "operator.registered",
          "default": "operator.registered",
          "title": "Event Type",
          "type": "string"
        },
        "operator_id": {
          "format": "uuid",
          "title": "Operator Id",
          "type": "string"
        },
        "timestamp": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Timestamp"
        }
      },
      "required": [
        "operator_id"
      ],
      "title": "OperatorRegisteredEvent",
      "type": "object"
    },
    "OperatorStatusChangedEvent": {
      "properties": {
        "event_type": {
          "const": "operator.status_changed",
          "default": "operator.status_changed",
          "title": "Event Type",
          "type": "string"
        },
        "operator_id": {
          "format": "uuid",
          "title": "Operator Id",
          "type": "string"
        },
        "status": {
          "enum": [
            "online",
            "busy",
            "offline"
          ],
          "title": "Status",
          "type": "string"
        }
      },
      "required": [
        "operator_id",
        "status"
      ],
      "title": "OperatorStatusChangedEvent",
      "type": "object"
    },
    "OperatorWrapUpEvent": {
      "properties": {
        "event_type": {
          "const": "operator.wrap_up",
          "default": "operator.wrap_up",
          "title": "Event Type",
          "type": "string"
        },
        "call_sid": {
          "title": "Call Sid",
          "type": "string"
        },
        "wrap_up_reason": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Wrap Up Reason"
        }
      },
      "required": [
        "call_sid"
      ],
      "title": "OperatorWrapUpEvent",
      "type": "object"
    },
    "PipelineErrorEvent": {
      "properties": {
        "event_type": {
          "const": "pipeline.error",
          "default": "pipeline.error",
          "title": "Event Type",
          "type": "string"
        },
        "data_source_id": {
          "format": "uuid",
          "title": "Data Source Id",
          "type": "string"
        },
        "error": {
          "title": "Error",
          "type": "string"
        }
      },
      "required": [
        "data_source_id",
        "error"
      ],
      "title": "PipelineErrorEvent",
      "type": "object"
    },
    "PipelineSyncCompletedEvent": {
      "properties": {
        "event_type": {
          "const": "pipeline.sync_completed",
          "default": "pipeline.sync_completed",
          "title": "Event Type",
          "type": "string"
        },
        "data_source_id": {
          "format": "uuid",
          "title": "Data Source Id",
          "type": "string"
        },
        "event_count": {
          "title": "Event Count",
          "type": "integer"
        },
        "duration_ms": {
          "title": "Duration Ms",
          "type": "integer"
        }
      },
      "required": [
        "data_source_id",
        "event_count",
        "duration_ms"
      ],
      "title": "PipelineSyncCompletedEvent",
      "type": "object"
    },
    "ReviewSubmittedEvent": {
      "properties": {
        "event_type": {
          "const": "review.submitted",
          "default": "review.submitted",
          "title": "Event Type",
          "type": "string"
        },
        "action": {
          "enum": [
            "approve",
            "reject",
            "correct",
            "batch_approve",
            "batch_reject"
          ],
          "title": "Action",
          "type": "string"
        },
        "item_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Item Id"
        },
        "entity_id": {
          "anyOf": [
            {
              "format": "uuid",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Entity Id"
        },
        "entity_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Entity Type"
        },
        "count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Count"
        }
      },
      "required": [
        "action"
      ],
      "title": "ReviewSubmittedEvent",
      "type": "object"
    },
    "SimulationTurnStoredEvent": {
      "properties": {
        "event_type": {
          "const": "simulation.turn_stored",
          "default": "simulation.turn_stored",
          "title": "Event Type",
          "type": "string"
        },
        "service_id": {
          "format": "uuid",
          "title": "Service Id",
          "type": "string"
        },
        "run_id": {
          "title": "Run Id",
          "type": "string"
        },
        "session_id": {
          "title": "Session Id",
          "type": "string"
        },
        "turn_index": {
          "title": "Turn Index",
          "type": "integer"
        },
        "state_before": {
          "title": "State Before",
          "type": "string"
        },
        "state_after": {
          "title": "State After",
          "type": "string"
        },
        "is_terminal": {
          "title": "Is Terminal",
          "type": "boolean"
        }
      },
      "required": [
        "service_id",
        "run_id",
        "session_id",
        "turn_index",
        "state_before",
        "state_after",
        "is_terminal"
      ],
      "title": "SimulationTurnStoredEvent",
      "type": "object"
    },
    "SurfaceArchivedEvent": {
      "properties": {
        "event_type": {
          "const": "surface.archived",
          "default": "surface.archived",
          "title": "Event Type",
          "type": "string"
        },
        "surface_id": {
          "format": "uuid",
          "title": "Surface Id",
          "type": "string"
        }
      },
      "required": [
        "surface_id"
      ],
      "title": "SurfaceArchivedEvent",
      "type": "object"
    },
    "SurfaceCreatedEvent": {
      "properties": {
        "event_type": {
          "const": "surface.created",
          "default": "surface.created",
          "title": "Event Type",
          "type": "string"
        },
        "surface_id": {
          "format": "uuid",
          "title": "Surface Id",
          "type": "string"
        },
        "entity_id": {
          "format": "uuid",
          "title": "Entity Id",
          "type": "string"
        },
        "channel": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel"
        },
        "fields_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fields Count"
        },
        "source": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Source"
        },
        "form_template_id": {
          "anyOf": [
            {
              "format": "uuid",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Form Template Id"
        },
        "review_required": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Review Required"
        }
      },
      "required": [
        "surface_id",
        "entity_id"
      ],
      "title": "SurfaceCreatedEvent",
      "type": "object"
    },
    "SurfaceDeliveredEvent": {
      "properties": {
        "event_type": {
          "const": "surface.delivered",
          "default": "surface.delivered",
          "title": "Event Type",
          "type": "string"
        },
        "surface_id": {
          "format": "uuid",
          "title": "Surface Id",
          "type": "string"
        },
        "entity_id": {
          "format": "uuid",
          "title": "Entity Id",
          "type": "string"
        },
        "channel": {
          "title": "Channel",
          "type": "string"
        },
        "channel_address": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Address",
          "x-phi": true
        },
        "delivery_status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Delivery Status"
        },
        "message_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message Id"
        },
        "short_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Short Url"
        }
      },
      "required": [
        "surface_id",
        "entity_id",
        "channel"
      ],
      "title": "SurfaceDeliveredEvent",
      "type": "object"
    },
    "SurfaceFieldSavedEvent": {
      "properties": {
        "event_type": {
          "const": "surface.field_saved",
          "default": "surface.field_saved",
          "title": "Event Type",
          "type": "string"
        },
        "surface_id": {
          "format": "uuid",
          "title": "Surface Id",
          "type": "string"
        },
        "entity_id": {
          "format": "uuid",
          "title": "Entity Id",
          "type": "string"
        },
        "field_key": {
          "title": "Field Key",
          "type": "string"
        }
      },
      "required": [
        "surface_id",
        "entity_id",
        "field_key"
      ],
      "title": "SurfaceFieldSavedEvent",
      "type": "object"
    },
    "SurfaceOpenedEvent": {
      "properties": {
        "event_type": {
          "const": "surface.opened",
          "default": "surface.opened",
          "title": "Event Type",
          "type": "string"
        },
        "surface_id": {
          "format": "uuid",
          "title": "Surface Id",
   

# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/json-schema/amigo-workspace-sseevent-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amigo-workspace-sseevent"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.