Sign in

v1

latestOpenAPI 3.0.02026-07-135965404.0 KB
Activity

Get webhook logs

Returns the webhook logs for your account. Use the available query parameters to filter the listing of activity that is returned.

NOTE: Total Results will always return as 0 to avoid querying data you're not using and stay as performant as possible.

Event Types

Webhooks are triggered by enabled event types for your account, which are configured on the developer settings page. Not all event types may be allowed for your account type. These are the valid options for event types:

  • resources.upload
  • resources.download
  • resources.delete
  • resources.createFolder
  • resources.rename
  • resources.move
  • resources.copy
  • resources.compress
  • resources.extract
  • shares.formSubmit
get/activity/webhooks

Query parameters

startDatestring date-time

Earliest date of entries to include in list

endDatestring date-time

Latest date of entries to include in list

endpointUrlstring uri

Webhook listener endpoint

eventstring
Example:resources.upload

Type of activity that triggered the webhook attempt

statusCodeinteger
Example:200

Response code from the webhook endpoint

resourcePathstring
Example:/Production

Path of the resource that triggered the webhook attempt

usernamestring
Example:exampleuser

Filter by triggering username.

offsetinteger

Records to skip before returning results.

limitinteger
Example:100

Limit of the records list

sortstring

Comma separated list sort params

Headers

ev-api-keystring required
Example:exampleaccount-zwSuWUZ8S38h33qPS8v0s

API Key

ev-access-tokenstring required
Example:19853ef63a0bc348024a9e4cfd4a92520d2dfd04e88d8679fb1ed6bc551593d1

Access Token

Response

Successful operation

responseStatusinteger

Http status code of the response.

totalResultsinteger

Total results found.

returnedResultsinteger

Number of results returned.

Example response

{
  "responseStatus": 200,
  "totalResults": 2,
  "returnedResults": 2,
  "data": [
    {
      "id": 12345,
      "type": "webhookActivity",
      "attributes": {
        "details": {
          "eventData": {
            "share": [
              {
                "recipients": [
                  {
                    "id": 2,
                    "type": "owner",
                    "hash": "fseowxan",
                    "email": "recipient@example.com",
                    "sent": true,
                    "created": "2017-01-26T18:10:47Z"
                  }
                ],
                "messages": [
                  {
                    "id": 397584,
                    "userId": 119394,
                    "shareId": 3544253,
                    "subject": "Files available for download",
                    "body": "You have files available for download.",
                    "created": "2017-01-26T18:10:47Z",
                    "modified": "2017-01-28T13:10:47Z"
                  }
                ]
              }
            ]
          }
        }
      }
    }
  ]
}