Events - List Events | Webex for Developers

List Events

List events in your organization. Several query parameters are available to filter the events returned in 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: attachmentActions, call_records, file_transcodings, files, meetingMessages, meetings, meetingTranscripts, memberships, messages, rooms, tabs

type

string

List events with a specific event type.

Possible values: created, updated, deleted, ended

actorId

string

List events performed by this person, by person ID.

from

string

List events which occurred after a specific date and time.

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]

string

The unique identifier for the event.

resource

Event Resource Enum

The type of resource in the event.

attachmentActions

string

State changed on a card attachment

call_records

string

A Webex call was made to/from a user

file_transcodings

string

State change on a file preview

files

string

State changed on a file download

meetingMessages

string

State changed on a meeting message, i.e. message exchanged as part of a meeting

meetings

string

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

meetingTranscripts

string

State change on a automatic transcript resource for Webex Assistant

memberships

string

State changed on a memberships resource

messages

string

State changed on a messages resource

rooms

string

State changed on a space classification

tabs

string

State changed on a room tabs in a space

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.

string

roomId

string

roomType

string

orgId

string

text

string

personId

string

personEmail

string

meetingId

string

creatorId

string

host

object

The meeting's host data

attendees

array

Common Identity (CI) authenticated meeting attendees

transcriptionEnabled

string

indicates whether or not the Voice Assistant was enabled during the meeting. If true a transcript should be available a couple minutes after the meeting ended at the meetingTranscripts resource

recordingEnabled

string

indicates if recording was enabled for all or parts of the meeting. If true a recording should be available shortly after the meeting ended at the recordings resource

hasPostMeetingsChat

string

indicates if chat messages were exchanged during the meeting in the meetings client (not the unified client). If true these messages can be accessed by a compliance officer at the postMeetingsChat resource. Meetings chat collection must be custom enabled.

corelationId

string

telephony; corelation id

callType

string

telephony; call types (examples VIDEO_DIALIN,VIDEO_DIALOUT,CASCADE,HYBRID_CASCADE,PSTN_SIP,PSTN_DIALIN,PSTN_DIALOUT,PSTN_ONLY_DIALIN,PSTN_ONLY_DIALOUT,H323,H323_IP,SIP_ENTERPRISE,SIP_MOBILE,SIP_NATIONAL,SIP_INTERNATIONAL,SIP_EMERGENCY,SIP_OPERATOR,SIP_SHORTCODE,SIP_TOLLFREE,SIP_PREMIUM,SIP_URI,SIP_INBOUND,UNKNOWN,ZTM,SIP_MEETING)

userId

string

telephony; user id of the CDR owner

userType

string

telephony; type of user (User,Anchor,AutomatedAttendantBasic,AutomatedAttendantStandard,AutomatedAttendantVideo,BroadworksAnywhere,CallCenterBasic,CallCenterPremium,CallCenterStandard,CollaborateBridge,ContactCenterAdaptor,FindMeFollowMe,FlexibleSeatingHost,GroupCall,GroupPaging,HuntGroup,LocalGateway,MeetMeConference,Place,RoutePoint,SystemVoicePortal,VoiceMailGroup,VoiceMailRetrieval,VoiceXML,VirtualLine,Unknown)

callDirection

string

telephony; ORIGINATING or TERMINATING

isCallAnswered

string

telephony; indicates if the call was answered

callDurationSeconds

string

telephony; duration of call in seconds

callStartTime

string

telephony; ISO 8601

callAnswerTime

string

telephony; ISO 8601

callTransferTime

string

telephony; ISO 8601

callingNumber

string

telephony; originating number

callingLineId

string

telephony

calledNumber

string

telephony; destination number

calledLineId

string

telephony

dialedDigits

string

telephony

callRedirectingNumber

string

telephony

callRedirectedReason

string

telephony

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.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
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.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
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.
504	Gateway Timeout	An 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}

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 person 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.

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,%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",
        "meetingId": "16ce696f75844d24b2d4fab04b4419af_I_183979003076423608",
        "creatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM",
        "transcriptionEnabled": "yes",
        "recordingEnabled": "yes",
        "hasPostMeetingsChat": "yes",
        "corelationId": "fdda8613-d34b-424c-8c6a-44ff2e19379c",
        "callType": "SIP_ENTERPRISE",
        "userId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU",
        "userType": "User",
        "callDirection": "ORIGINTATING",
        "isCallAnswered": "true",
        "callDurationSeconds": "192",
        "callStartTime": "2023-02-08T06:12:43.976Z",
        "callAnswerTime": "2023-02-08T06:12:47.012Z",
        "callTransferTime": "2023-02-08T06:15:19.112Z",
        "callingNumber": "910481234",
        "callingLineId": "211",
        "calledNumber": "4089671221",
        "calledLineId": "219",
        "dialedDigits": "123",
        "callRedirectingNumber": "",
        "callRedirectedReason": "",
        "created": "2016-05-16T21:34:59.324Z"
      }
    }
  ]
}