MCP Tool: get_event_registry

Retrieves the event registry for a specific team, showing all available events that can be used to trigger workflows. This tool helps you discover what events are available for workflow configuration.

Example Prompt

Get event registry for team "TEAM001"

Input Parameters

NameTypeRequiredDescription
teamIdstringYesThe team ID to fetch event registry for

Response Fields

Below are the fields you may see in each event object in the response:
FieldTypeDescription
idstringThe unique identifier of the event
namestringThe name of the event
descriptionstringThe description of the event
categorystringThe category of the event
schemaobjectThe JSON schema for the event payload
isActivebooleanWhether the event is active and available
createdAtstring (ISO8601)The creation timestamp
updatedAtstring (ISO8601)The last update timestamp

Sample Response

{
  "data": [
    {
      "id": "EVENT001",
      "name": "ticket.created",
      "description": "Triggered when a new ticket is created",
      "category": "ticket",
      "schema": {
        "type": "object",
        "properties": {
          "ticketId": {
            "type": "string",
            "description": "The unique identifier of the ticket"
          },
          "title": {
            "type": "string",
            "description": "The title of the ticket"
          },
          "priority": {
            "type": "string",
            "enum": ["low", "medium", "high", "urgent"],
            "description": "The priority level of the ticket"
          },
          "team": {
            "type": "string",
            "description": "The team assigned to the ticket"
          },
          "accountId": {
            "type": "string",
            "description": "The account ID associated with the ticket"
          },
          "createdBy": {
            "type": "string",
            "description": "The user who created the ticket"
          }
        },
        "required": ["ticketId", "title", "priority", "team"]
      },
      "isActive": true,
      "createdAt": "2025-07-24T07:19:10.258Z",
      "updatedAt": "2025-07-24T07:19:10.258Z"
    },
    {
      "id": "EVENT002",
      "name": "ticket.updated",
      "description": "Triggered when a ticket is updated",
      "category": "ticket",
      "schema": {
        "type": "object",
        "properties": {
          "ticketId": {
            "type": "string",
            "description": "The unique identifier of the ticket"
          },
          "changes": {
            "type": "object",
            "description": "The changes made to the ticket"
          },
          "updatedBy": {
            "type": "string",
            "description": "The user who updated the ticket"
          }
        },
        "required": ["ticketId", "changes"]
      },
      "isActive": true,
      "createdAt": "2025-07-24T07:19:10.258Z",
      "updatedAt": "2025-07-24T07:19:10.258Z"
    },
    {
      "id": "EVENT003",
      "name": "comment.created",
      "description": "Triggered when a new comment is created",
      "category": "comment",
      "schema": {
        "type": "object",
        "properties": {
          "commentId": {
            "type": "string",
            "description": "The unique identifier of the comment"
          },
          "entityType": {
            "type": "string",
            "enum": ["ticket", "account", "contact"],
            "description": "The type of entity the comment is on"
          },
          "entityId": {
            "type": "string",
            "description": "The ID of the entity"
          },
          "author": {
            "type": "string",
            "description": "The author of the comment"
          },
          "visibility": {
            "type": "string",
            "enum": ["public", "private"],
            "description": "The visibility of the comment"
          }
        },
        "required": ["commentId", "entityType", "entityId", "author"]
      },
      "isActive": true,
      "createdAt": "2025-07-24T07:19:10.258Z",
      "updatedAt": "2025-07-24T07:19:10.258Z"
    },
    {
      "id": "EVENT004",
      "name": "account.created",
      "description": "Triggered when a new account is created",
      "category": "account",
      "schema": {
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "description": "The unique identifier of the account"
          },
          "name": {
            "type": "string",
            "description": "The name of the account"
          },
          "industry": {
            "type": "string",
            "description": "The industry of the account"
          },
          "createdBy": {
            "type": "string",
            "description": "The user who created the account"
          }
        },
        "required": ["accountId", "name"]
      },
      "isActive": true,
      "createdAt": "2025-07-24T07:19:10.258Z",
      "updatedAt": "2025-07-24T07:19:10.258Z"
    }
  ],
  "status": true,
  "message": "Event registry retrieved successfully!",
  "timestamp": "2025-07-25T12:50:38.937Z"
}