KapworkKapwork Partner API
API Reference

Webhooks

Real-time notifications for receivable changes

In Development

Webhooks are in development and will be available in a future release.

Overview

Webhooks will provide real-time notifications when receivable data changes, delivering events to your endpoint.


Planned Events

EventDescription
receivable.createdA new receivable has been synced
receivable.updatedReceivable data has changed
receivable.status_changedReceivable status has changed

Example Payload

{
  "id": "evt_abc123",
  "type": "receivable.status_changed",
  "created_at": "2026-01-07T10:30:00Z",
  "data": {
    "receivable_id": "rcv_550e8400e29b41d4a716446655440000",
    "vendor": {
      "id": "vendor-uuid",
      "name": "Acme Corp"
    },
    "debtor": {
      "id": "debtor-uuid",
      "name": "BigBuyer Inc"
    },
    "previous_status": "PENDING",
    "new_status": "APPROVED",
    "previous_portal_status": "SUBMITTED",
    "new_portal_status": "APPROVED FOR PAYMENT",
    "changed_at": "2026-01-07T10:30:00Z"
  }
}

Current Alternative

Until webhooks are available, use polling:

Daily Sync

GET /v1/receivables

Returns receivables updated in the last 24 hours.

Schedule-Based Polling

Check estimated_next_update_at and query after that timestamp for fresh data.

Single Receivable Refresh

GET /v1/receivables/:id

Early Access

Contact your Kapwork account representative or email support@kapwork.com to join the early access list.

On this page