Skip to content

Event Types

A change is called a Subscribed Event, and the type of change is called a Subscribed Event Type.

Note: Only Account Administrators can access Subscribed Events.

Operations

Fetching a list of Subscribed Event Types

Request

Returns a list of all Event Types tracked by Subscribed Events.

The event type schema, accessible using the subscribed_event_type_schemas key, is metadata that shows the structure of all events. The event types schema includes documentation for the events and fields. You can reference the event types schema as you build your application that processes subscribed events.

GET
/subscribed_events/event_types
curl -i -X GET \
  https://api.mavenlink.com/api/v1/subscribed_events/event_types

Responses

A list of Event Types have been retrieved.

Bodyapplication/json
subscribed_event_typesArray of strings

A complete list of Subscribed Event Types.

subscribed_event_type_schemasobject
Response
{
  "subscribed_event_types": [
    "string"
  ],
  "subscribed_event_type_schemas": {
    "property1": {
      "name": "string",
      "description": "string",
      "fields": {
        "property1": {
          "name": "string",
          "type": "string",
          "description": "string",
          "fields": { … }
        },
        "property2": {
          "name": "string",
          "type": "string",
          "description": "string",
          "fields": { … }
        }
      }
    },
    "property2": {
      "name": "string",
      "description": "string",
      "fields": {
        "property1": {
          "name": "string",
          "type": "string",
          "description": "string",
          "fields": { … }
        },
        "property2": {
          "name": "string",
          "type": "string",
          "description": "string",
          "fields": { … }
        }
      }
    }
  }
}