Types of events - Yorlet Documentation

Yorlet API

Billing

Checkout

Core

Guardrails

Leads

Leasing

Loyalty

Maintenance

Owners

Payments

Terminal

Test Helpers

This is a complete list of the events Yorlet currently sends. Subscribe to these on your webhook endpoints to receive notifications when they occur.

account

Event	Description
`account.updated`	Occurs whenever an account is updated.

approval

Event	Description
`approval.approved`	Occurs whenever an approval is approved.
`approval.created`	Occurs whenever an approval is created.
`approval.denied`	Occurs whenever an approval is denied.
`approval.executed`	Occurs whenever an approved action is executed.

account_collection

Event	Description
`account_collection.approved`	Occurs whenever an account collection is approved.
`account_collection.canceled`	Occurs whenever an account collection is canceled.
`account_collection.created`	Occurs whenever an account collection is created.
`account_collection.updated`	Occurs whenever an account collection is updated.

application

Event	Description
`application.accepted`	Occurs whenever an application is accepted.
`application.canceled`	Occurs whenever an application is canceled.
`application.created`	Occurs whenever an application is created.
`application.completed`	Occurs whenever an application is completed.
`application.updated`	Occurs whenever an application is updated.

building

Event	Description
`building.created`	Occurs whenever a building is created.
`building.deleted`	Occurs whenever a building is deleted.
`building.updated`	Occurs whenever a building is updated.

checkout_session

Event	Description
`checkout_session.canceled`	Occurs whenever a checkout session is canceled.
`checkout_session.created`	Occurs whenever a checkout session is created.
`checkout_session.completed`	Occurs whenever a checkout session is completed.

contract

Event	Description
`contract.created`	Occurs whenever a contract is created.
`contract.completed`	Occurs whenever a contract is completed.
`contract.out_for_signature`	Occurs whenever a contract is sent out for signature.
`contract.voided`	Occurs whenever a contract is voided.
`contract.unvoided`	Occurs whenever a contract is unvoided.

customer

Event	Description
`customer.created`	Occurs whenever a customer is created.
`customer.deleted`	Occurs whenever a customer is deleted.
`customer.updated`	Occurs whenever a customer is updated.

redaction

Event	Description
`redaction.created`	Occurs whenever a customer redaction is created and PII wiping starts.
`redaction.failed`	Occurs whenever a customer redaction fails. Creating the same redaction again retries it.
`redaction.redacted`	Occurs whenever a customer redaction completes and PII has been wiped.

message

Event	Description
`message.received`	Occurs whenever an inbound message is received.
`message.sent`	Occurs whenever a message is sent through the Emails API.

dispute

Event	Description
`dispute.created`	Occurs whenever a dispute is created.
`dispute.resolved`	Occurs whenever a dispute is resolved.

invoice

Event	Description
`invoice.created`	Occurs whenever a invoice is created.
`invoice.finalization_failed`	Occurs whenever a invoice fails finalization.
`invoice.finalized`	Occurs whenever a invoice is finalized and marked as open.
`invoice.paid`	Occurs whenever a invoice is paid.
`invoice.payment_failed`	Occurs whenever a invoice payment fails.
`invoice.sent`	Occurs whenever an invoice email is sent.
`invoice.voided`	Occurs whenever a invoice is voided.

leads.enquiry

Event	Description
`leads.enquiry.attached`	Occurs whenever a qualification configuration is attached to an enquiry.
`leads.enquiry.created`	Occurs whenever an enquiry is created.
`leads.enquiry.updated`	Occurs whenever an enquiry is updated.

leads.viewing

Event	Description
`leads.viewing.created`	Occurs whenever a viewing is created.
`leads.viewing.updated`	Occurs whenever a viewing is updated.

letter

Event	Description
`letter.canceled`	Occurs whenever a letter is canceled.
`letter.created`	Occurs whenever a letter is created.
`letter.failed`	Occurs whenever sending a letter fails.
`letter.sent`	Occurs whenever a letter is submitted for printing and postage.

loyalty.message

Event	Description
`loyalty.message.created`	Occurs whenever a loyalty message is created.
`loyalty.message.failed`	Occurs whenever a loyalty message fails to send.
`loyalty.message.sent`	Occurs whenever a loyalty message is sent.

loyalty.program

Event	Description
`loyalty.program.created`	Occurs whenever a loyalty program is created.
`loyalty.program.expired`	Occurs whenever a loyalty program expires.
`loyalty.program.updated`	Occurs whenever a loyalty program is updated.

loyalty.program_event

Event	Description
`loyalty.program_event.canceled`	Occurs whenever a loyalty program event is canceled.
`loyalty.program_event.created`	Occurs whenever a loyalty program event is created.
`loyalty.program_event.expired`	Occurs whenever a loyalty program event expires.
`loyalty.program_event.succeeded`	Occurs whenever a loyalty program event succeeds.
`loyalty.program_event.updated`	Occurs whenever a loyalty program event is updated.

maintenance_issue

Event	Description
`maintenance.issue.created`	Occurs whenever a maintenance issue is created.
`maintenance.issue.deleted`	Occurs whenever a maintenance issue is deleted.
`maintenance.issue.resolved`	Occurs whenever a maintenance issue is resolved.
`maintenance.issue.updated`	Occurs whenever a maintenance issue is updated.

maintenance_job

Event	Description
`maintenance.job.assigned`	Occurs whenever a maintenance job is assigned.
`maintenance.job.canceled`	Occurs whenever a maintenance job is canceled.
`maintenance.job.completed`	Occurs whenever a maintenance job is completed.
`maintenance.job.created`	Occurs whenever a maintenance job is created.
`maintenance.job.deleted`	Occurs whenever a maintenance job is deleted.
`maintenance.job.scheduled`	Occurs whenever a maintenance job visit is scheduled.
`maintenance.job.updated`	Occurs whenever a maintenance job is updated.

maintenance_quote

Event	Description
`maintenance.quote.approved`	Occurs whenever a maintenance quote is approved.
`maintenance.quote.canceled`	Occurs whenever a maintenance quote is canceled.
`maintenance.quote.created`	Occurs whenever a maintenance quote is created.
`maintenance.quote.deleted`	Occurs whenever a maintenance quote is deleted.
`maintenance.quote.rejected`	Occurs whenever a maintenance quote is rejected.
`maintenance.quote.requested`	Occurs whenever a maintenance quote is requested from a supplier.
`maintenance.quote.updated`	Occurs whenever a maintenance quote is updated.

owners

Event	Description
`owner.created`	Occurs whenever an owner is created.
`owner.updated`	Occurs whenever an owner is updated.

payment_method

Event	Description
`payment_method.chargeable`	Occurs whenever a payment method becomes chargeable.
`payment_method.created`	Occurs whenever a payment method is created.
`payment_method.failed`	Occurs whenever a payment method fails.

payment_method_transaction

Event	Description
`payment_method_transaction.created`	Occurs whenever a payment method transaction is created.

payment_session

Event	Description
`payment_session.created`	Occurs whenever a payment session is created.
`payment_session.paid`	Occurs whenever a payment session is paid.

prism

Event	Description
`prism.scheduled_query.completed`	Occurs whenever a scheduled Prism query finishes running.

renewal_intent

Event	Description
`renewal_intent.canceled`	Occurs whenever an renewal intent is canceled.
`renewal_intent.created`	Occurs whenever an renewal intent is created.
`renewal_intent.completed`	Occurs whenever an renewal intent is completed.
`renewal_intent.updated`	Occurs whenever an renewal intent is updated.

resident

Event	Description
`resident.created`	Occurs whenever a resident is created.
`resident.updated`	Occurs whenever a resident is updated.

subscription

Event	Description
`subscription.canceled`	Occurs whenever a subscription is canceled.
`subscription.completed`	Occurs whenever a subscription is completed.
`subscription.created`	Occurs whenever a subscription is created.
`subscription.updated`	Occurs whenever a subscription is updated.

tenancy

Event	Description
`tenancy.activated`	Occurs whenever an tenancy is activated.
`tenancy.canceled`	Occurs whenever an tenancy is canceled.
`tenancy.created`	Occurs whenever an tenancy is created.
`tenancy.completed`	Occurs whenever an tenancy is completed.
`tenancy.updated`	Occurs whenever an tenancy is updated.

thread

Event	Description
`thread.created`	Occurs whenever a thread is created.
`thread.updated`	Occurs whenever a thread is updated.

transaction

Event	Description
`transaction.canceled`	Occurs whenever a transaction is canceled.
`transaction.created`	Occurs whenever a transaction is created.
`transaction.payment_failed`	Occurs whenever a transaction fails.
`transaction.processing`	Occurs whenever a transaction is processing.
`transaction.succeeded`	Occurs whenever a transaction has succeeded.

unit

Event	Description
`unit.archived`	Occurs whenever a unit is archived.
`unit.created`	Occurs whenever a unit is created.
`unit.deleted`	Occurs whenever a unit is deleted.
`unit.updated`	Occurs whenever a unit is updated.