Webhooks
Boom can send certain customer related events to the URL you provide.
All messages are sent via POST with content type "application/json". In case of network error or if your server would reply with non-20x HTTP status, there will be 2 retries with a 1 minute interval.
Every message contains an event parameter describing its type. Other fields depend on type
Contact support to set your webhook URL for production and sandbox environments.
Event | Description | Other fields |
|---|---|---|
customer_registered | Happens right after customer registered (entered name, phone, email) in our system via API or themselves, on partner's portal. | customer_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, |
enrollment_pending | Customer entered all the data about the lease, enrollment awaits for approval. | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, |
enrollment_approved | All verifications passed, enrollment is approved, charge for service placed on invoice per plan. | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, |
enrollment_rejected | In case verification fail, enrollment will be rejected and customer denied of service (happens rarely, mostly fraud and failed identity verifications). | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, |
customer_unenrolled | Customer canceled their subscription. Further calls to API with this customer_id will fail. | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, |
furnishment_finished | Triggered after account is reported. | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, |
issue_pending | Triggered when there is an issue with enrollment. | customer_id: String, enrollment_id: String issue: Object |
issue_resolved | Triggered when customer resolves the issue. | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, issue: Object |
rental_payment_verified | Triggered when a rental verification is verified. | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, transactions: Array of Object |
enrollment_verification_verified | Triggered when an enrollment verification is verified. | customer_id: String, enrollment_id: String, verificaion_id: String, memo: String review_method: String (automatic/manual) kind: string |
enrollment_verification_rejected | Triggered when an enrollment verification is rejected. | customer_id: String, enrollment_id: String, verificaion_id: String, memo: String review_method: String (automatic/manual) kind: string |
enrollment_moved_out | Triggered when an enrollment moved out. | customer_id: String, enrollment_id: String, customer_first_name: String, customer_last_name: String, customer_email: String, customer_phone: String, customer_external_id: String, |
Event | Description | Other fields |
|---|---|---|
application_approved | Emitted in case application is approved. |
event:
dependents:
pets
first_name
last_name
phone
email
desired_move_in_date
unit
address
monthly_rent_amount
status |
application_conditionally_approved | Emitted in case application is conditionally approved. | event:
dependents:
pets
first_name
last_name
phone
email
desired_move_in_date
unit
address
monthly_rent_amount
status |
application_created | Emitted in case application created. | event:
dependents:
pets
first_name
last_name
phone
email
desired_move_in_date
unit
address
monthly_rent_amount
status |
application_completed | Emitted in case application is completed. | event:
dependents:
pets
first_name
last_name
phone
email
desired_move_in_date
unit
address
monthly_rent_amount
status |
applicant_created | Emitted in case applicant created. | event:
dependents:
pets
first_name
last_name
phone
email
desired_move_in_date
unit
address
monthly_rent_amount
status |
applicant_completed | Emitted in case applicant completed the application. | event:
dependents:
pets
first_name
last_name
phone
email
desired_move_in_date
unit
address
monthly_rent_amount
status |
