Events List

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

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 to help customize the response.

Request

Header

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

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.

{

"@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

{
  "@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"
      }
    }
  ]
}