Events

Your account's event log: everything that happened to your parties, certificates, requests and settings, in the same feed the dashboard shows. The log is append-only, so it doubles as a change feed: store the last id you processed and ask for everything after it. Webhooks deliver the same events as they happen (Webhooks).

Only customer-visible events are served. Staff-only events never appear here or in webhooks. An event that belongs to one of your individuals is not served.

The event entity

{
  "id": 9120044,
  "event_type": "Vendor Became Compliant",
  "message": "Acme Electric became compliant",
  "details": null,
  "party_id": 191537,
  "certificate_id": 5521,
  "project_id": null,
  "compliance_request_id": 88120,
  "w9_id": null,
  "signing_request_id": null,
  "signing_template_id": null,
  "parent_event_id": null,
  "user_id": null,
  "api_key_id": null,
  "created_at": "2026-10-07T14:03:11Z",
  "links": { "self": "/api/v2/events/9120044", "party": "/api/v2/parties/191537" }
}

Fields of features your account does not use are present with an empty value.

GET /events

Events in id order, oldest first, in the collection envelope.

The id of one of your individuals as party_id is also 422 naming party_id.

A status sync loop:

GET /api/v2/events?since_id=9120044&event_type[]=Vendor%20Became%20Compliant&event_type[]=Vendor%20Became%20Noncompliant&per_page=200

Repeat with the largest id you received until has_more is false.

since_id is not a lossless cursor: an event's id is assigned when it is written, and a long-running operation can make an event with a lower id visible after you have read past it. Re-poll with an overlap (from an id, or a since time, a few minutes back) and de-duplicate by id.

GET /events/:id

One event. 404 for a staff-only event or another account's event. Also 404 for an event of one of your individuals.

Event types

The full, current list is served by GET /webhook_event_types (Webhook subscriptions): every customer-visible type the app records. Types are never renamed. The ones below are the types this reference relies on.

Parties and compliance

Custom fields

Email health

Custom field events

The custom field definition events name the field in their message, for example Custom field "Area" updated (name, where it appears) by API key "Sync" (the name after the change). details describes the field in the API's own words (field_type is its API name, applies_to a list, as Custom fields serves them):

{
  "custom_field_id": 12,
  "name": "Area",
  "field_type": "string",
  "applies_to": ["parties", "projects"],
  "show_on_triage_queue": false,
  "changes": [
    { "attribute": "name", "old": "Region", "new": "Area" },
    { "attribute": "applies_to", "old": ["parties"], "new": ["parties", "projects"] }
  ]
}

changes is on Custom Field Definition Updated only (one entry per changed attribute: name, field_type, applies_to, show_on_triage_queue). Custom Field Definition Deleted adds values_removed, the number of values deleted with the field. A record's custom field value changing is not one of these events: on parties it is part of Party Edited.

Edit details

For a Party Edited event, the message names the fields that changed and never their values, for example Name, Contact Email and City changed. details is a JSON-encoded string (parse it) holding an object with one entry per changed field:

{
  "changes": [
    { "key": "name", "name": "Name", "old": "Acme Electric", "new": "Acme Electric LLC" },
    { "key": "email_address", "name": "Contact Email", "old": "[email protected]", "new": "[email protected]" },
    { "key": "insurance_requirement_id", "name": "Insurance Requirement", "old": 12, "new": 15,
      "old_display": "Standard", "new_display": "High Risk" },
    { "key": "tags", "name": "Tags", "old": [3], "new": [3, 5], "old_display": ["Electrical"], "new_display": ["Electrical", "Union"] },
    { "key": "custom_field:12", "name": "Region", "old": null, "new": { "value": "Central", "user_id": null } }
  ]
}

A custom field counts as changed only when its served value changes. A blank value (empty, or only spaces) is no value, the same rule the parties endpoints use, so saving a blank field again is not a change, and clearing a field shows its old value and null. Contact people, insurance agents and certificate uploads have their own records and are not listed here.

Webhooks

Users and settings

W-9s

A certificate converted into a W-9 records no W-9 event: its Certificate Submitted already fired, and that certificate id is no longer served once converted. Find such W-9s with GET /w9s?updated_since= (W-9s).

Document signing

API keys