Skip to main content
The offboarding event object represents a single step in the offboarding lifecycle. Events form an immutable audit trail of every action taken during the offboarding process, from initial request through final resolution.
​
offboardingEventId
string
O identificador unico do evento de offboarding (UUIDv7).
​
eventType
string
The type of event. One of: REQUESTED, RETENTION_STARTED, CAMPAIGNS_SUSPENDED, CAMPAIGNS_INACTIVATED, BILLING_PAUSED, INVOICES_MARKED_DRAFT, INVOICES_MARKED_UNCOLLECTIBLE, RETENTION_CANCELLED, RETAINED, CANCELLED, CAMPAIGNS_REACTIVATED, BILLING_RESUMED, REACTIVATED.
​
createdBy
string
The user ID (UUIDv7) who triggered the event.
​
createdAt
string
Timestamp when the event was created (ISO 8601).
{
  "offboardingEventId": "019525fe-5c44-7dc7-cfeb-7f9a1b3d5e7b",
  "eventType": "RETENTION_STARTED",
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-03-25T23:30:00.000Z"
}