Events - List Events | Cisco Webex for Developers

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

type

string

List events with a specific event type.

Possible values: created, updated, deleted

actorId

string

List events performed by this person, by ID.

from

string

List events which occurred after a specific date and time.

string

List events which occurred before a specific date and time.

max

number

Limit the maximum number of events in the response.

Default: 100

Response Properties

items

array

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

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

string

roomId

string

roomType

string

text

string

personId

string

personEmail

string

created

string

Response Codes

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

Code	Status	Description
200	OK	Successful request with body content.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The 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.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The 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.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The 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.
429	Too Many Requests	Too 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.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.

GET

/v1/events{?resource,type,actorId,from,to,max}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

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.

https://webexapis.com/v1/events?resource=%5Bobject%20Object%5D,%5Bobject%20Object%5D&type=%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",
        "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": "2016-05-16T21:34:59.324Z"
      }
    }
  ]
}