Skip to content
Clym

Case management

Case, case user, and case type events.

Triggered when a case is created.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a case is updated.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a case status changes.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a case is archived

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a case is permanently deleted

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a new message is added to a case

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a case message is redacted

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a case field is redacted

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a case user verification email is sent.

Request bodyapplication/json
eventstringrequired
The `case.user.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case user record.
Show properties
kindstringenumoptional
Entity type; always `caseUser`.
Possible values: caseUser
dataobjectoptional
Case user entity. For privacy, only the identifier and creation timestamp are included — no contact details.
Show properties
idstringoptional
Case user ID
created_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.user.verified",
  "params": {},
  "entity": {
    "kind": "caseUser",
    "data": {
      "id": "string",
      "created_at": "string"
    }
  }
}

Triggered when a case user's email is verified.

Request bodyapplication/json
eventstringrequired
The `case.user.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case user record.
Show properties
kindstringenumoptional
Entity type; always `caseUser`.
Possible values: caseUser
dataobjectoptional
Case user entity. For privacy, only the identifier and creation timestamp are included — no contact details.
Show properties
idstringoptional
Case user ID
created_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.user.verified",
  "params": {},
  "entity": {
    "kind": "caseUser",
    "data": {
      "id": "string",
      "created_at": "string"
    }
  }
}

Triggered to notify the account a case opened.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered to notify the account of a case reply.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered to notify the account a case closed.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered to notify the account a case archived.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered to notify the account a case is past due.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered to notify the user a case opened.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered to notify the user of a reply.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 2 notification when a case opens.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 2 notification when a case closes.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 2 notification when a case progresses.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 3 notification when a case opens.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 4 notification when a case opens.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 4 notification when a case closes.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 4 notification when a case progresses.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 5 notification when a case opens.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 5 notification when a case closes.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered on template 5 notification when a case progresses.

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 48 hours before first response is due

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 24 hours before first response is due

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 14 days before case auto-closes

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 7 days before case auto-closes

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 48 hours before case auto-closes

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 24 hours before case auto-closes

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 14 days before case auto-archives

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 7 days before case auto-archives

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 48 hours before case auto-archives

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 24 hours before case auto-archives

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered 24 hours after case is past due

Request bodyapplication/json
eventstringrequired
The case event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related case record.
Show properties
kindstringenumoptional
Entity type; always `case`.
Possible values: case
dataobjectoptional
Case entity. Related records are referenced by ID.
Show properties
idstringoptional
Case ID
public_idstringoptional
Public-facing case ID
statusstringenumoptional
Case status
Possible values: PENDING OPEN IN_PROGRESS CLOSED EXPIRED ARCHIVED
first_due_atstringnullableoptional
First due date
resolution_due_atstringnullableoptional
Resolution due date
system_case_type_idstringnullableoptional
System case type ID
property_case_type_idstringnullableoptional
Property case type ID
system_case_type_category_idstringnullableoptional
System case type category ID
property_case_type_category_idstringnullableoptional
Property case type category ID
system_case_type_reporting_idstringnullableoptional
System case type reporting channel ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID
created_atstringoptional
updated_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case.created",
  "params": {},
  "entity": {
    "kind": "case",
    "data": {
      "id": "string",
      "public_id": "string",
      "status": "PENDING",
      "first_due_at": "string",
      "resolution_due_at": "string",
      "system_case_type_id": "string",
      "property_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "system_case_type_reporting_id": "string",
      "property_id": "string",
      "company_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}

Triggered when a new case type is created

Request bodyapplication/json
eventstringrequired
The `case_type.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseType`.
Possible values: propertyCaseType
dataobjectoptional
Property case type entity
Show properties
idstringoptional
Property case type ID
typestringenumoptional
Case type source discriminator
Possible values: property
namestringoptional
Case type name
descriptionstringoptional
Case type description
link_iconstringoptional
Link icon
link_namestringoptional
Link name
form_namestringoptional
Form name shown above the form
form_descriptionstringoptional
Form description (markdown)
external_reporting_channelsobject[]optional
Additional configured reporting channels
Show properties
typestringenumoptional
Possible values: EMAIL PHONE_NUMBER ADDRESS LINK
valuestringoptional
sortintegeroptional
system_case_type_idstringoptional
System case type ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID

Response 200: Acknowledged

Payload

{
  "event": "case_type.created",
  "params": {},
  "entity": {
    "kind": "propertyCaseType",
    "data": {
      "id": "string",
      "type": "property",
      "name": "string",
      "description": "string",
      "link_icon": "string",
      "link_name": "string",
      "form_name": "string",
      "form_description": "string",
      "external_reporting_channels": [{
        "type": {},
        "value": {},
        "sort": {}
      }],
      "system_case_type_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when a case type is updated.

Request bodyapplication/json
eventstringrequired
The `case_type.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseType`.
Possible values: propertyCaseType
dataobjectoptional
Property case type entity
Show properties
idstringoptional
Property case type ID
typestringenumoptional
Case type source discriminator
Possible values: property
namestringoptional
Case type name
descriptionstringoptional
Case type description
link_iconstringoptional
Link icon
link_namestringoptional
Link name
form_namestringoptional
Form name shown above the form
form_descriptionstringoptional
Form description (markdown)
external_reporting_channelsobject[]optional
Additional configured reporting channels
Show properties
typestringenumoptional
Possible values: EMAIL PHONE_NUMBER ADDRESS LINK
valuestringoptional
sortintegeroptional
system_case_type_idstringoptional
System case type ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID

Response 200: Acknowledged

Payload

{
  "event": "case_type.created",
  "params": {},
  "entity": {
    "kind": "propertyCaseType",
    "data": {
      "id": "string",
      "type": "property",
      "name": "string",
      "description": "string",
      "link_icon": "string",
      "link_name": "string",
      "form_name": "string",
      "form_description": "string",
      "external_reporting_channels": [{
        "type": {},
        "value": {},
        "sort": {}
      }],
      "system_case_type_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when a case type is modified

Request bodyapplication/json
eventstringrequired
The `case_type.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseType`.
Possible values: propertyCaseType
dataobjectoptional
Property case type entity
Show properties
idstringoptional
Property case type ID
typestringenumoptional
Case type source discriminator
Possible values: property
namestringoptional
Case type name
descriptionstringoptional
Case type description
link_iconstringoptional
Link icon
link_namestringoptional
Link name
form_namestringoptional
Form name shown above the form
form_descriptionstringoptional
Form description (markdown)
external_reporting_channelsobject[]optional
Additional configured reporting channels
Show properties
typestringenumoptional
Possible values: EMAIL PHONE_NUMBER ADDRESS LINK
valuestringoptional
sortintegeroptional
system_case_type_idstringoptional
System case type ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID

Response 200: Acknowledged

Payload

{
  "event": "case_type.created",
  "params": {},
  "entity": {
    "kind": "propertyCaseType",
    "data": {
      "id": "string",
      "type": "property",
      "name": "string",
      "description": "string",
      "link_icon": "string",
      "link_name": "string",
      "form_name": "string",
      "form_description": "string",
      "external_reporting_channels": [{
        "type": {},
        "value": {},
        "sort": {}
      }],
      "system_case_type_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when a case type is deleted

Request bodyapplication/json
eventstringrequired
The `case_type.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseType`.
Possible values: propertyCaseType
dataobjectoptional
Property case type entity
Show properties
idstringoptional
Property case type ID
typestringenumoptional
Case type source discriminator
Possible values: property
namestringoptional
Case type name
descriptionstringoptional
Case type description
link_iconstringoptional
Link icon
link_namestringoptional
Link name
form_namestringoptional
Form name shown above the form
form_descriptionstringoptional
Form description (markdown)
external_reporting_channelsobject[]optional
Additional configured reporting channels
Show properties
typestringenumoptional
Possible values: EMAIL PHONE_NUMBER ADDRESS LINK
valuestringoptional
sortintegeroptional
system_case_type_idstringoptional
System case type ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID

Response 200: Acknowledged

Payload

{
  "event": "case_type.created",
  "params": {},
  "entity": {
    "kind": "propertyCaseType",
    "data": {
      "id": "string",
      "type": "property",
      "name": "string",
      "description": "string",
      "link_icon": "string",
      "link_name": "string",
      "form_name": "string",
      "form_description": "string",
      "external_reporting_channels": [{
        "type": {},
        "value": {},
        "sort": {}
      }],
      "system_case_type_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when a case type field is deleted

Request bodyapplication/json
eventstringrequired
The event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type field record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseTypeField`.
Possible values: propertyCaseTypeField
dataobjectoptional
Property case type field entity
Show properties
idstringoptional
Field ID
typestringenumoptional
Possible values: property
is_piibooleanoptional
Whether the field holds PII
sortintegeroptional
Sort order
field_namestringoptional
Field name
field_typestringenumoptional
Field type
Possible values: INPUT TEXTAREA SELECT NUMBER BOOLEAN MULTI_INPUT ACK
field_valuesstring[]optional
Values (for SELECT/MULTI_INPUT)
visibilitystringenumoptional
Field visibility
Possible values: HIDDEN OPTIONAL REQUIRED
descriptionstringoptional
Field description
notesstringoptional
Internal notes
property_case_type_idstringoptional
Property case type ID
system_case_type_field_idstringoptional
System field ID
property_idstringoptional
company_idstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case_type.field.deleted",
  "params": {},
  "entity": {
    "kind": "propertyCaseTypeField",
    "data": {
      "id": "string",
      "type": "property",
      "is_pii": false,
      "sort": 0,
      "field_name": "string",
      "field_type": "INPUT",
      "field_values": ["string"],
      "visibility": "HIDDEN",
      "description": "string",
      "notes": "string",
      "property_case_type_id": "string",
      "system_case_type_field_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when a case type category is deleted

Request bodyapplication/json
eventstringrequired
The event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type category record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseTypeCategory`.
Possible values: propertyCaseTypeCategory
dataobjectoptional
Property case type category entity
Show properties
idstringoptional
Category ID
typestringenumoptional
Possible values: property
sortintegeroptional
Sort order
namestringoptional
Category name
descriptionstringoptional
Category description
is_enabledbooleanoptional
Whether category is enabled
system_case_type_category_idstringoptional
System category ID
property_case_type_idstringoptional
Property case type ID

Response 200: Acknowledged

Payload

{
  "event": "case_type.category.deleted",
  "params": {},
  "entity": {
    "kind": "propertyCaseTypeCategory",
    "data": {
      "id": "string",
      "type": "property",
      "sort": 0,
      "name": "string",
      "description": "string",
      "is_enabled": false,
      "system_case_type_category_id": "string",
      "property_case_type_id": "string"
    }
  }
}

Triggered when a case type reporting config is deleted.

Request bodyapplication/json
eventstringrequired
The event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type reporting record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseTypeReporting`.
Possible values: propertyCaseTypeReporting
dataobjectoptional
Property case type reporting entity
Show properties
idstringoptional
Reporting ID
typestringenumoptional
Possible values: property
is_enabledbooleanoptional
Whether reporting is enabled
sortintegeroptional
Sort order
system_case_type_idstringoptional
System case type ID
system_case_type_reporting_idstringoptional
System reporting ID
property_case_type_idstringoptional
Property case type ID
property_idstringoptional
company_idstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case_type.reporting.deleted",
  "params": {},
  "entity": {
    "kind": "propertyCaseTypeReporting",
    "data": {
      "id": "string",
      "type": "property",
      "is_enabled": false,
      "sort": 0,
      "system_case_type_id": "string",
      "system_case_type_reporting_id": "string",
      "property_case_type_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when a case type policy is deleted

Request bodyapplication/json
eventstringrequired
The `case_type.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseType`.
Possible values: propertyCaseType
dataobjectoptional
Property case type entity
Show properties
idstringoptional
Property case type ID
typestringenumoptional
Case type source discriminator
Possible values: property
namestringoptional
Case type name
descriptionstringoptional
Case type description
link_iconstringoptional
Link icon
link_namestringoptional
Link name
form_namestringoptional
Form name shown above the form
form_descriptionstringoptional
Form description (markdown)
external_reporting_channelsobject[]optional
Additional configured reporting channels
Show properties
typestringenumoptional
Possible values: EMAIL PHONE_NUMBER ADDRESS LINK
valuestringoptional
sortintegeroptional
system_case_type_idstringoptional
System case type ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID

Response 200: Acknowledged

Payload

{
  "event": "case_type.created",
  "params": {},
  "entity": {
    "kind": "propertyCaseType",
    "data": {
      "id": "string",
      "type": "property",
      "name": "string",
      "description": "string",
      "link_icon": "string",
      "link_name": "string",
      "form_name": "string",
      "form_description": "string",
      "external_reporting_channels": [{
        "type": {},
        "value": {},
        "sort": {}
      }],
      "system_case_type_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when case type access is created.

Request bodyapplication/json
eventstringrequired
The `case_type.access.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case access record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseAccess`.
Possible values: propertyCaseAccess
dataobjectoptional
Property case access entity
Show properties
idstringoptional
Access ID
can_read_redactedbooleanoptional
Can read redacted content
can_write_redactedbooleanoptional
Can write redacted content
statusesstring[]optional
Statuses this grant applies to
account_idstringoptional
Account ID granted access
created_by_idstringoptional
Account ID that created the grant
system_case_type_idstringoptional
System case type ID
system_case_type_category_idstringoptional
System category ID
property_case_type_category_idstringoptional
Property category ID
property_idstringoptional
company_idstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case_type.access.deleted",
  "params": {},
  "entity": {
    "kind": "propertyCaseAccess",
    "data": {
      "id": "string",
      "can_read_redacted": false,
      "can_write_redacted": false,
      "statuses": ["PENDING"],
      "account_id": "string",
      "created_by_id": "string",
      "system_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when case type access is updated.

Request bodyapplication/json
eventstringrequired
The `case_type.access.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case access record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseAccess`.
Possible values: propertyCaseAccess
dataobjectoptional
Property case access entity
Show properties
idstringoptional
Access ID
can_read_redactedbooleanoptional
Can read redacted content
can_write_redactedbooleanoptional
Can write redacted content
statusesstring[]optional
Statuses this grant applies to
account_idstringoptional
Account ID granted access
created_by_idstringoptional
Account ID that created the grant
system_case_type_idstringoptional
System case type ID
system_case_type_category_idstringoptional
System category ID
property_case_type_category_idstringoptional
Property category ID
property_idstringoptional
company_idstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case_type.access.deleted",
  "params": {},
  "entity": {
    "kind": "propertyCaseAccess",
    "data": {
      "id": "string",
      "can_read_redacted": false,
      "can_write_redacted": false,
      "statuses": ["PENDING"],
      "account_id": "string",
      "created_by_id": "string",
      "system_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when case type access is deleted.

Request bodyapplication/json
eventstringrequired
The `case_type.access.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case access record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseAccess`.
Possible values: propertyCaseAccess
dataobjectoptional
Property case access entity
Show properties
idstringoptional
Access ID
can_read_redactedbooleanoptional
Can read redacted content
can_write_redactedbooleanoptional
Can write redacted content
statusesstring[]optional
Statuses this grant applies to
account_idstringoptional
Account ID granted access
created_by_idstringoptional
Account ID that created the grant
system_case_type_idstringoptional
System case type ID
system_case_type_category_idstringoptional
System category ID
property_case_type_category_idstringoptional
Property category ID
property_idstringoptional
company_idstringoptional

Response 200: Acknowledged

Payload

{
  "event": "case_type.access.deleted",
  "params": {},
  "entity": {
    "kind": "propertyCaseAccess",
    "data": {
      "id": "string",
      "can_read_redacted": false,
      "can_write_redacted": false,
      "statuses": ["PENDING"],
      "account_id": "string",
      "created_by_id": "string",
      "system_case_type_id": "string",
      "system_case_type_category_id": "string",
      "property_case_type_category_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

Triggered when case management translations are updated

Request bodyapplication/json
eventstringrequired
The `case_type.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property case type record.
Show properties
kindstringenumoptional
Entity type; always `propertyCaseType`.
Possible values: propertyCaseType
dataobjectoptional
Property case type entity
Show properties
idstringoptional
Property case type ID
typestringenumoptional
Case type source discriminator
Possible values: property
namestringoptional
Case type name
descriptionstringoptional
Case type description
link_iconstringoptional
Link icon
link_namestringoptional
Link name
form_namestringoptional
Form name shown above the form
form_descriptionstringoptional
Form description (markdown)
external_reporting_channelsobject[]optional
Additional configured reporting channels
Show properties
typestringenumoptional
Possible values: EMAIL PHONE_NUMBER ADDRESS LINK
valuestringoptional
sortintegeroptional
system_case_type_idstringoptional
System case type ID
property_idstringoptional
Property ID
company_idstringoptional
Company ID

Response 200: Acknowledged

Payload

{
  "event": "case_type.created",
  "params": {},
  "entity": {
    "kind": "propertyCaseType",
    "data": {
      "id": "string",
      "type": "property",
      "name": "string",
      "description": "string",
      "link_icon": "string",
      "link_name": "string",
      "form_name": "string",
      "form_description": "string",
      "external_reporting_channels": [{
        "type": {},
        "value": {},
        "sort": {}
      }],
      "system_case_type_id": "string",
      "property_id": "string",
      "company_id": "string"
    }
  }
}

© 2026 ClymTermsPrivacy policyCookie policy