DOdotfile
Webhooks

List all webhook logs

Changed on

Returns the webhook events delivered for your workspace — each with its full payload and every delivery attempt — filterable by case, individual, event and date. Webhook logs are retained for a limited period (30 days by default); events older than your retention period are not returned.

See also

Learn more about Webhook logs
Learn more about Filtering, Sorting and Pagination

get/v1/webhook-logs

Request

  • Base URL
    https://api.dotfile.com
  • Auth
    API key in header X-DOTFILE-API-KEY

Query parameters

eventstring

Filter items by the event.{operator} field.
You can use the eq, not_eq, in and not_in operators, the eq operator being the default.
Comma separated for multiple values (in and not_in).

case_idstring

Filter items by the case_id.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

individual_idstring

Filter items by the individual_id.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

company_idstring

Filter items by the company_id.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

created_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the created_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

sortstring

Use this parameter to sort query results.
If not specified, sorted in descending order with values of field created_at.
Available fields are created_at.

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 50.

Response

List of webhook events delivered for the workspace

ℹ️ Click to see full payload

Example response

{
  "pagination": {
    "count": 42
  }
}

Changes