Webhooks
Boom can send certain customer related events to the URL you provide. Please, contact support to set this URL for production or development environment.
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 about 1 minute interval.
Every message contain "event" parameter describing its type, other fields depend on it.
Currently supported events (it's possible that more event types will be added in future)
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 |
enrollment_pending | customer entered all the data about the lease, enrollment awaits for approval | customer_id: String, enrollment_id: String |
enrollment_approved | All verifications passed, enrollment is approved, charge for service placed on invoice per plan. | customer_id: String, enrollment_id: String |
enrollment_rejected | In case verification fail, enrollment will be rejected and customer denied of service (happens rarely, mostly fraud and failed identity verifiations) | customer_id: String, enrollment_id: String |
customer_unenrolled | customer canceled their subscription. Further calls to API with this customer_id will fail. | customer_id: String, enrollment_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 |