Webhooks

This documentation outlines all available webhook endpoints and their associated payloads. Each webhook follows a standard response format:

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "[entity_type]"
  },
  "resource": {
    "id": 0,
    "type": "[resource_type]"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Where

[event_type]

can be one of:

created: When a new resource is created
updated: When an existing resource is modified
deleted: When a resource is removed

Webhook Entity Types Reference

Relation Group

Entity	Webhook Type Value
Relation	`relation`
Relation entity connected	`relation`, `relation_entity` in related

Relation Entity Group

Entity	Webhook Type Value
Relation Entity	`relation_entity`
Address	`relation_entity_address`
Communications	`relation_entity_communications`
Correspondence	`relation_entity_correspondence`
Trade Names	`relation_entity_trade_names`
Registrations	`relation_entity_registrations`
Documents	`relation_entity_documents`
External Users	`relation_entity_external_users`
Relation Entity Logs	`relation_entity_relation_entity_logs`
UDF Fields	`relation_entity_udf_fields`

Case Group

Entity	Webhook Type Value
Case	`case`
Claims	`case_claims`
Agenda Items	`case_agenda_items`
Correspondence	`case_correspondence`
Email	`case_email`
Payments	`case_payments`
Documents	`case_documents`
Expenses	`case_expenses`
Disputes	`case_disputes`
Payment Plans	`case_payment_plans`
Case Logs	`case_case_logs`
Time Registrations	`case_time_registrations`
UDF Fields	`case_udf_fields`

Note: These type values are used in the

type

field of both the

resource

and

related

objects in webhook payloads. The

resource

type will always be one of the top-level entities (

relation

relation_entity

, or

case

), while the

related

type can be any of the above values depending on what was modified.

Examples

Relation Group

Relation

Triggered when a relation is created, updated, or deleted.

{
  "event_type": "[event_type]",
  "related": {
    "id": null,
    "type": null
  },
  "resource": {
    "id": 0,
    "type": "relation"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation entity connected

Triggered when a relation entity is connected or disconnected from a relation.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity"
  },
  "resource": {
    "id": 0,
    "type": "relation"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Group

Relation Entity

Triggered for changes to the core relation entity record.

{
  "event_type": "[event_type]",
  "related": {
    "id": null,
    "type": null
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Address

Triggered when addresses associated with a relation entity are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_address"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Communications

Triggered for changes to communication records associated with a relation entity.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_communications"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Correspondence

Triggered when correspondence records for a relation entity are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_correspondence"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Trade Names

Triggered for changes to trade names associated with a relation entity.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_trade_names"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Registrations

Triggered when registration records for a relation entity are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_registrations"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Documents

Triggered for changes to documents linked to a relation entity.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_documents"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity External Users

Triggered when external user records associated with a relation entity are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_external_users"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity Logs

Triggered for changes to the audit logs of a relation entity.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_relation_entity_logs"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Relation Entity UDF Fields

Triggered when user-defined fields for a relation entity are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "relation_entity_udf_fields"
  },
  "resource": {
    "id": 0,
    "type": "relation_entity"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Group

Case

Triggered for changes to the core case record.

{
  "event_type": "[event_type]",
  "related": {
    "id": null,
    "type": null
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Claims

Triggered when claims associated with a case are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_claims"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Agenda Items

Triggered for changes to agenda items linked to a case.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_agenda_items"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Correspondence

Triggered when correspondence records for a case are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_correspondence"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Email

Triggered for changes to email records associated with a case.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_email"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Payments

Triggered when payment records for a case are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_payments"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Documents

Triggered for changes to documents linked to a case.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_documents"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Expenses

Triggered when expense records associated with a case are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_expenses"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Disputes

Triggered for changes to dispute records linked to a case.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_disputes"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Payment Plans

Triggered when payment plan records for a case are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_payment_plans"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Logs

Triggered for changes to the audit logs of a case.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_case_logs"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Employees

Triggered when employee records associated with a case are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_employees"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case Time Registrations

Triggered for changes to time registration records linked to a case.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_time_registrations"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}

Case UDF Fields

Triggered when user-defined fields for a case are modified.

{
  "event_type": "[event_type]",
  "related": {
    "id": 0,
    "type": "case_udf_fields"
  },
  "resource": {
    "id": 0,
    "type": "case"
  },
  "timestamp": "2025-01-28T23:44:55+00:00"
}