Skip to main content

List Instance Webhook Events

GET 
/api/integrations/17track/instances/:instance/webhooks

Paginated audit log of every 17TRACK webhook received for this integration instance — one row per inbound webhook, stored before it is processed. Each row records the event type, tracking number, result, the status transition (status_from → status_to), processing time and any error message, plus a precomputed summary string like "In Transit → Delivered".

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Filters (filter[...]):

  • search — contains match on tracking number, event type, or the from/to status
  • event_type, result, tracking_number, status_from, status_to — text filters; the bare key is an exact match (comma-separated values match any of them), and filter[<field>.<operator>] takes any of contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty
  • id — numeric filter
  • received_at, created_at — date filters, filter[<field>.<operator>] with is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, past_week, past_month, past_year, past_days, days_ago, .... Dates are Y-m-d in the account timezone; between takes two comma-separated dates.

filter_groups accepts a base64-encoded JSON filter tree for AND/OR combinations: {"conjunction": "and", "children": [{"type": "condition", "condition": {"column": "<field>.<operator>", "operator": "<operator>", "value": "..."}}, {"type": "group", "group": {"conjunction": "or", "children": [...]}}]}. When it is present it takes precedence over the flat filter[...] parameters.

Unknown filter names are rejected with 400 Bad Request.

Allowed sorts: id, received_at, created_at, event_type, result (default: -received_at).

Responses:

  • 200 OK — paginated webhook event rows
  • 400 Bad Request — a filter name that is not allowed
  • 404 Not Found — instance id does not exist

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type