This is a list of all the event types we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume only these types exist.
You'll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against. Events that occur on sub-resources like line_item.updated might trigger the parent's update event in select cases.
Event types
💰 Debt Events
 |
|---|
| Ophelos Debt Status Flow |
Basic Events
Occurs whenever a new debt record is created.
Occurs whenever a debt record is updated.
Occurs whenever a debt record is deleted from our databases
Status Transition Events
debt.initializing
Occurs when debt is being created
Occurs when client informs that the debt is ready to process
Occurs when client requests to pause the debt
Occurs when client withdraws the debt
Occurs when debt is being analysed by Data
Occurs when debt is resumed after being paused
Occurs when communication has been sent to the customer
Occurs when communication has been established with customer
debt.contact_failed
Occurs when communication with customer has failed
debt.enriching
Occurs when debt is being enriched by Data
Occurs when debt is returned to the client
debt.discharged
Occurs when debt is discharged/written-off
Occurs when customer is arranging payment
Occurs when customer is paying
Occurs when debt settlement is paid
Occurs when debt is fully paid
Occurs when customer has queried the debt
Occurs when customer has disputed the debt
Occurs when customer has defaulted on a payment plan arrangement to the debt
debt.follow_up_required
Occurs when follow up is required
Occurs when client has adjusted the debt
Occurs when debt is being assessed by Customer Operations
Occurs when customer has been given options to recover paying
Occurs when debt is closed due to process exhaustion
debt.legal_protection
Occurs when debt is under legal protection
Terminal State Events
The following events represent terminal states that mark the end of a debt's lifecycle.
debt.settled
Occurs when debt settlement is paid
debt.paid
Occurs when debt is fully paid
Occurs when debt is closed due to process exhaustion
Occurs when debt is returned to the client
Occurs when client withdraws the debt
debt.deleted
Occurs whenever a debt record is deleted from our databases
debt.discharged
Occurs when debt is discharged/written-off
🧾 Invoice Events
Basic Events
invoice.created
Occurs when a new invoice is created
invoice.updated
Occurs when a invoice is updated
invoice.deleted
Occurs when a invoice is deleted
Status Transition Events
invoice.issued
Occurs when a invoice is required to pay by the customer
invoice.paid
Occurs when the specific invoice is marked as paid
invoice.withdrawn
Occurs when the invoice is withdrawn from the customers responsibility to pay.
📝 Line Item Events
Basic Events
line_item.created
Occurs when a new line item is created
line_item.updated
Occurs when a line item is updated
line_item.deleted
Occurs when a line item is deleted
💳 Payment Events
Basic Events
payment.created
Occurs when a new payment record is created
payment.updated
Occurs when a payment record is updated
payment.deleted
Occurs when a payment record is deleted
Status Transition Events
Occurs when payment is initially scheduled
Occurs when scheduled payment is canceled
payment.preparing
Occurs when preparing a payment with our payment provider
Occurs when Customer is making payment with our payment provider
Occurs when our payment reports a successfully received payment
Occurs when payment is disputed
Occurs when payment fails to process
Occurs when payment is refunded
📅 Payment Plan Events
Basic Events
payment_plan.created
Occurs when a new payment plan is created
payment_plan.updated
Occurs when a payment plan is updated
payment_plan.deleted
Occurs when a payment plan is deleted
Status Transition Events
payment_plan.suggested
Occurs when payment plan is suggested to customer
payment_plan.activated
Occurs when payment plan becomes active
👤 Customer Events
Basic Events
Occurs when the customer profile is created
Occurs when the customer profile is updated
Occurs when the customer profile is deleted
📞 Customer Contact Detail Events
Basic Events
customer_contact_detail.created
Occurs when a customer contact detail is created
customer_contact_detail.updated
Occurs when a customer contact detail is updated
customer_contact_detail.deleted
Occurs when a customer contact detail is deleted
Status Transition Events
customer_contact_detail.unverified
Occurs when the customer contact detail is marked as unverified
customer_contact_detail.verified
Occurs when the customer contact detail is marked as verified
customer_contact_detail.undeliverable
Occurs when the customer contact detail is marked as undeliverable
customer_contact_detail.deleted
Occurs when a customer contact detail is deleted
📤 Communication Events
Basic Events
communication.created
Occurs when a new communication record is created
communication.updated
Occurs when a communication is updated
communication.deleted
Occurs when a communication is deleted
Status Transition Events
communication.delivered
Occurs when the communication is reported delivered by the service
communication.failed
Occurs when the communication is marked as failed by the service
🏛️ Organisation Events
Basic Events
organisation.created
Occurs when a new organisation is created
organisation.updated
Occurs when a organisation is updated
organisation.deleted
Occurs when a organisation is deleted
📞 Organisation Contact Detail Events
organisation_contact_detail.created
Occurs when a organisation contact detail is created
organisation_contact_detail.updated
Occurs when a organisation contact detail is updated
organisation_contact_detail.deleted
Occurs when a organisation contact detail is updated