TRtruv
Webhooks

List webhook request history

Changed on

Returns a paginated list of webhook requests filtered by the provided criteria. Only webhook requests from the last 30 days are available.

get/v1/webhook-requests/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/webhook-requests/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Query parameters

created_at__gtestring date-time

Filter records created on or after this ISO-8601 timestamp. Defaults to 30 days ago if not provided. Cannot be older than 30 days from current time. Must be less than or equal to created_at__lte if both are provided.

created_at__ltestring date-time

Filter records created on or before this ISO-8601 timestamp.

event_type'task-status-updated' | 'order-status-updated' | 'order-created' | 'link-connected' | 'link-disconnected' | 'order-refresh-failed' | 'link-deleted' | 'employment-created' | 'employment-updated' | 'profile-created' | 'profile-updated' | 'statements-created' | 'statements-updated' | 'shifts-created' | 'shifts-updated' | 'bank-accounts-created' | 'bank-accounts-updated' | 'certification-completed' | 'order-finalized' | 'order-batch-completed'
Example:task-status-updated

Filter by webhook event type.

status_codeinteger

Filter by exact HTTP status code.

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

Response

Paginated list of webhook requests

nextstring nullable

Link to next page

previousstring nullable

Link to previous page

Example response

{
  "results": [
    {
      "webhook_id": "48427a36d43c4d5aa6324bc06c692456",
      "event_type": "task-status-updated",
      "event_created_at": "2024-01-15T10:30:00Z",
      "status_code": 200,
      "webhook_payload": {
        "webhook_id": "a3f5b7c9d1e2f4a6b8c0d2e4f6a8b0c2",
        "event_type": "order-status-updated",
        "event_created_at": "2026-01-27T00:00:16.279921Z",
        "product": "assets",
        "link_id": null,
        "user_id": "b4c6d8e0f2a4b6c8d0e2f4a6b8c0d2e4",
        "order_id": "c5d7e9f1a3b5c7d9e1f3a5b7c9d1e3f5",
        "status": "expired"
      },
      "webhook_url": "https://example.com/webhooks/truv"
    }
  ]
}

Changes

  • 16345eb80970Revision changes
    • warning

      added the new order-batch-completed enum value to the // response property for the response status

    • info

      added the new enum value order-batch-completed to the query request parameter event_type

  • e58688835e25Revision changes
    • breaking

      the // response property's min was decreased from 100.00 to 0.00 for the response status