Skip to main content

Protest events (protest.*)

Protest of receivables at a notary office (cartório). As with negativation, every protest triggered by the collection rule goes through mandatory human review before being sent. data is always a lean reference object.

protest.review_required​

Fires when a collection rule step requests a protest: the record is created as pending and a review task goes to the review queue.

{
  "event": "protest.review_required",
  "timestamp": "2026-07-23T06:10:00.000Z",
  "organizationId": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
  "data": {
    "chargeId": "4a2b6c8d-1e3f-4a5b-9c7d-2e4f6a8b0c1d",
    "personId": "7c1e9f2a-3b4d-4c5e-8f6a-1b2c3d4e5f60",
    "protestRecordId": "4b6d8f0a-2c4e-4a6c-9e1b-3d5f7a9c1e3b",
    "amount": "1512.50"
  }
}

protest.registered​

Fires when the receivable is sent to the notary office (after approval). The charge moves to protested.

{
  "event": "protest.registered",
  "timestamp": "2026-07-24T11:05:00.000Z",
  "organizationId": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
  "data": {
    "protestId": "4b6d8f0a-2c4e-4a6c-9e1b-3d5f7a9c1e3b",
    "chargeId": "4a2b6c8d-1e3f-4a5b-9c7d-2e4f6a8b0c1d",
    "personId": "7c1e9f2a-3b4d-4c5e-8f6a-1b2c3d4e5f60",
    "amount": "1512.50"
  }
}

protest.paid​

Fires when a protested receivable is paid. data follows the family's reference shape:

{
  "event": "protest.paid",
  "timestamp": "2026-07-28T09:40:00.000Z",
  "organizationId": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
  "data": {
    "protestId": "4b6d8f0a-2c4e-4a6c-9e1b-3d5f7a9c1e3b",
    "chargeId": "4a2b6c8d-1e3f-4a5b-9c7d-2e4f6a8b0c1d",
    "personId": "7c1e9f2a-3b4d-4c5e-8f6a-1b2c3d4e5f60",
    "amount": "1512.50"
  }
}

protest.cancelled​

Fires when the protest is cancelled/stayed (only occurs for records already sent or served notice).

{
  "event": "protest.cancelled",
  "timestamp": "2026-07-26T16:15:00.000Z",
  "organizationId": "0f7a3c1e-2b4d-4e6f-8a9b-1c2d3e4f5a6b",
  "data": {
    "protestId": "4b6d8f0a-2c4e-4a6c-9e1b-3d5f7a9c1e3b",
    "chargeId": "4a2b6c8d-1e3f-4a5b-9c7d-2e4f6a8b0c1d",
    "personId": "7c1e9f2a-3b4d-4c5e-8f6a-1b2c3d4e5f60"
  }
}