---
title: "Get webhook logs"
method: GET
path: "/activity/webhooks"
tags: ["Activity"]
---

# Get webhook logs

`GET /activity/webhooks`

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](/docs/account/09-settings/06-developer-settings). 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

## Query parameters

- `startDate` string, date-time
- `endDate` string, date-time
- `endpointUrl` string, uri
- `event` string
- `statusCode` integer
- `resourcePath` string
- `username` string
- `offset` integer
- `limit` integer
- `sort` string

## Headers

- `ev-api-key` string, required
- `ev-access-token` string, required

## Response `200`

Successful operation

- WebhookActivityResponse — Session activity list response
  - `responseStatus` integer — Http status code of the response.
  - `totalResults` integer — Total results found.
  - `returnedResults` integer — Number of results returned.
  - `data` WebhookActivityEntry[]
    - `id` integer
    - `type` 'webhookActivity'
    - `attributes` union
      - WebhookActivityAttributesV2
        - `webhookId` integer — Unique ID of webhook configuration
        - `webhookFormat` string — What version of webhook message is being sent `v2`
        - `attemptId` string — Event - retry identifier
        - `accountId` string — Unique ID of account
        - `resend` boolean — Whether this attempt was a re-send of a previous attempt
        - `endpointUrl` string, uri — The URL the message was sent to
        - `event` 'resources.upload' | 'resources.download' | 'resources.delete' | 'resources.rename' | 'resources.copy' | 'resources.move' | 'resources.compress' | 'resources.extract' | 'resources.createFolder' | 'shares.formSubmit' — Event type
        - `status` integer — HTTP Status Code returned by webhook listener
        - `ipAddress` string — IP Address of related activity
        - `response` string — Body of web response returned by webhook listener
        - `details` object
          - `attemptId` string — Entry - retry identifier
          - `accountName` string — Account master username
          - `eventTimestamp` string, date-time — Date and time event originally took place
          - `ipAddress` string — IP address of related activity
          - `protocol` string — Type of connection used for related activity
          - `username` string — Username logged for related activity. May refer to someone who is not a user of the account, such as a share recipient or "publ
          - `event` string — Type of related activity
          - `eventData` object
            - `resources` object[]
              - …
            - `formDetails` object[]
              - …
            - `share` object[]
              - …
            - `transferStatus` string — For uploads, and downloads, whether the file transferred OK. `success` means the transfer did not have errors
        - `webhookPath` string — Path that webhook is watching
        - `resourcePath` string — Path of resource that matched webhook
        - `username` string — Username of related activity
        - `created` string — Date and time of webhook message being generated by system
      - WebhookActivityAttributesV1
        - `webhookId` integer — Unique ID of webhook configuration
        - `webhookFormat` string — What version of webhook message is being sent `v1`
        - `attemptId` string — Event - retry identifier
        - `accountId` string — Unique ID of account
        - `resend` boolean — Whether this attempt was a re-send of a previous attempt
        - `endpointUrl` string, uri — The URL the message was sent to
        - `event` 'resources.upload' | 'resources.download' | 'resources.delete' | 'resources.rename' | 'resources.copy' | 'resources.move' | 'resources.compress' | 'resources.extract' | 'resources.createFolder' | 'shares.formSubmit' — Event type
        - `status` integer — HTTP Status Code returned by webhook listener
        - `ipAddress` string — IP Address of related activity
        - `response` string — Body of web response returned by webhook listener
        - `details` object
          - `attemptId` string — Entry - retry identifier
          - `accountName` string — Account master username
          - `protocol` string — Type of connection used for related activity
          - `username` string — Username logged for related activity. May refer to someone who is not a user of the account, such as a share recipient or "publ
          - `event` string — Type of related activity
          - `attempt` integer — Number of times the system has attempted to send
        - `webhookPath` string — Path that webhook is watching
        - `resourcePath` string — Path of resource that matched webhook
        - `username` string — Username of related activity
        - `created` string — Date and time of webhook message being generated by system

---

[API](https://skmtc.net/prismic/apis/exavault-api.md) · [All operations](https://skmtc.net/prismic/apis/exavault-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prismic/exavault-api/revisions/a1bd874b5960/schema)
