List Events

List events in your organization. Several query parameters are available to filter the response.

Long result sets will be split into pages.

GET/v1/events
Query Parameters
Name
Description
resource
string

List events with a specific resource type.

type
string

List events with a specific event type.

actorId
string

List events performed by this person, by ID.

from
string

List events which occurred after a specific date and time.

to
string

List events which occurred before a specific date and time.

max
number

Limit the maximum number of events in the response.

Response Properties
Name
Description
id
string

The unique identifier for the event.

resource
Event Resource Enum

The type of resource in the event.

type
Event Type Enum

The action which took place in the event.

appId
string

The ID of the application for the event.

actorId
string

The ID of the person who performed the action.

orgId
string

The ID of the organization for the event.

created
string

The date and time of the event.

data
object

Event data representation

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/events{?resource,type,actorId,from,to,max}
Log in to try the API.
Header
Parameters
  • List events with a specific resource type.
  • List events with a specific event type.
  • List events performed by this person, by ID.
  • List events which occurred after a specific date and time.
  • List events which occurred before a specific date and time.
  • Limit the maximum number of events in the response.
Example Response
{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
      "resource": "messages",
      "type": "created",
      "appId": "null",
      "actorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "orgId": "OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
      "created": "2016-05-16T21:34:59.324Z",
      "data": {
        "id": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
        "roomId": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
        "roomType": "group",
        "text": "PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W.",
        "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
        "personEmail": "matt@example.com",
        "created": "2015-10-18T14:26:16+00:00"
      }
    }
  ]
}