Online Docs

Events List

Retrieve the list of all events in the specified channel within a team.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
GET api/events
--x-appvity-channelId: [ChannelID]
--x-appvity-teamid: [TeamID]
--Cookie: graphNodeCookie=[ID]
```
## URL Endpoint

api/events

## Method

GET.

## Parameters

This method supports the $orderby, $filter and $count [OData Filter](/OnlineDoc-VI/odoc/eTask_Rest_API_Document/08-03-02.html) to help customize the response.

## Request
**Header**

–x-appvity-channelId: [ChannelID]
–x-appvity-teamid: [TeamID]
–Cookie: graphNodeCookie=[ID]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

**Body**

This method does not supply the request body.

## Response

If successful, this method returns a `200 OK` response code and the list of events objects in the response body.

```json
{

"@odata.context": "https://schema.appvity.com/odata/$metadata#events",
"@odata.count": 1,
"value": [
{
"enable": true ,
"_id": [EventId],
"entityType": [entityType],
"eventName": [EventName]
"triggerType": [Trigger],
"conditionsOps": [and/or],
"conditions": [Condition],
"actionType": "SendMail",
"action": [ActionObject],
"isSystem": true/false ,
"tenantId": [tenantId],
"teamId": [TeamID],
"channelId": [ChannelID]
"internalId": [InternalID],
"updatedAt": [UpdatedTime],
"updatedBy": [UpdatedUser]
}
]
}

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
"@odata.context": "https://schema.appvity.com/odata/$metadata#events",
"@odata.count": 1,
"value": [
{
"enable": true,
"_id": "5f6075704d596392f5422d3e",
"entityType": "task",
"eventName": "Create a new task",
"triggerType": "ITEM_CREATED",
"conditionsOps": "and",
"conditions": [
{
"ops": "and",
"conditions": [
{
"field": "body",
"ops": "Has Value",
"value": ""
}
]
}
],
"actionType": "SendMail",
"action": {
"sendAs": "team.etask.mail@anadea",
"to": {
"projectManager": false,
"whoCreateTask": false,
"whoAssignedTask": true,
"specificPeople": false,
"people": []
},
"cc": {
"projectManager": false,
"whoCreateTask": false,
"whoAssignedTask": false,
"specificPeople": false,
"people": []
},
"bcc": {
"projectManager": false,
"whoCreateTask": false,
"whoAssignedTask": false,
"specificPeople": false,
"people": []
}
},
"isSystem": true,
"tenantId": "df7abg9c-c05a-4fc9-b958-64faered911d",
"teamId": "19:15c258785b4040699180e7a8ad6c6014@thread.tacv2",
"channelId": "19:15c258785b4040699180e7a8ad6c6014@thread.tacv2",
"internalId": 1,
"updatedAt": "2020-09-24T07:05:10.048Z",
"updatedBy": {
"name": "Oliver Neal",
"username": "oliver@anadea.com",
"sourceId": "5083cb81-35f4-4abd-ba2d-e7b9965c1f89"
}
}
]
}

Comment

Was this article helpful?
Thanks For Your Feedback