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
resource
string

List events with a specific resource type.

Possible values: messages, memberships, meetings, meetingTranscripts, tabs, rooms, attachmentActions, files, file_transcodings
type
string

List events with a specific event type.

Possible values: created, updated, deleted, ended
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. If unspecified or set to a time in the future, lists events up to the present.

max
number

Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.

Default: 100
Response Properties
items
array[Event]
id
string

The unique identifier for the event.

resource
Event Resource Enum

The type of resource in the event.

messages
string

State changed on the messages resource

memberships
string

State changed on the memberships resource

meetings
string

State change on a meeting ( here combined with type = 'ended' )

meetingTranscripts
string

State change on the automatic transcript resource for Webex Assistant

tabs
string

State changed on the room tabs in a space

rooms
string

State changed on a space classification

attachmentActions
string

State changed on a card attachment

files
string

State changed on a file download

file_transcodings
string

State change on a file preview

type
Event Type Enum

The action which took place in the event.

created
string

The resource has been created

updated
string

A property on the resource has been updated

deleted
string

The resource has been deleted

ended
string

The meeting has ended

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

The event’s data representation. This object will contain the event's resource, such as memberships, messages, meetings, tabs, rooms or attachmentActions at the time the event took place.

id
string
roomId
string
roomType
string
orgId
string
text
string
personId
string
personEmail
string
creatorId
string
host
object

The meetings host data

attendees
array

CI authenticated meeting attendees

created
string
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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
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.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/events{?resource,type,actorId,from,to,max}
Log in to try the API.
Header
Query 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. If unspecified or set to a time in the future, lists events up to the present.
  • Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.
https://webexapis.com/v1/events?resource=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&type=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&actorId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC1lZjhjYzY1ZDA4NDI&from=2018-01-01T00:00:00.000Z&to=2018-01-02T00:00:00.000Z&max=100
200 / OK
{
  "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",
        "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU",
        "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",
        "creatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM",
        "created": "2016-05-16T21:34:59.324Z"
      }
    }
  ]
}