--- title: Webhooks slug: webhooks docTags: createdAt: 2023-10-20T18:44:33.278Z --- Boom sends real-time webhook notifications to your server when key events occur in BoomReport (rent reporting) and BoomScreen (tenant screening). Use webhooks to keep your systems in sync — for example, updating a tenant's status when their enrollment is approved, or triggering an internal workflow when a screening application is submitted. ### How it works - All webhooks are sent as POST requests with `Content-Type: application/json` - Every payload includes an event field identifying the event type, plus a unique `request_id` field, which is also available as a `X-Boom-Idempotency-Key` header on the request - We retry failed webhooks 2 times, at 1-minute intervals. The conditions that cause us to reattempt delivery are as follows: - HTTP status code 3xx, 429, 5xx - If the URL is unreachable (DNS dailure, connection refused, TLS failure) - If the request takes more than 5 seconds - Webhook URLs are configured in **Settings → Webhooks**. ### Authenticating webhooks - Each webhook request can include an `X-API-KEY` header with the secret token configured for your webhook endpoint - Validate this token on your server to verify the request is from Boom Every message contains an `event` parameter describing its type. Other fields depend on `type` :::hint{type="info"} Webhooks can be configured in **Settings -> Webhooks**. ::: # Currently supported events ### Boom Report Events | **Event** | **Description** | | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | customer\_registered | Sent when a customer is created in Boom (via API or partner portal). The customer has provided name, phone, and email but has not yet started enrollment.

**Payload:**
`{ `
` "event": "customer_registered", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123" `
` }` | | enrollment\_pending | The customer completed their enrollment application. Identity, lease, and landlord verifications are now in progress.

**Payload:**
`{ `
` "event": "enrollment_pending", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` `
` }` | | enrollment\_approved | All verifications passed and the enrollment is active. Rent payments will be reported to credit bureaus going forward.

**Payload:**
`{ `
` "event": "enrollment_approved", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456" `
` }` | | enrollment\_rejected | The enrollment was rejected due to a failed verification (identity, lease, or landlord). The customer will not be reported.

**Payload:**
`{ `
` "event": "enrollment_rejected", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456" `
` }` | | customer\_unenrolled | The customer was unenrolled from rent reporting. Can be customer-initiated, partner-initiated, or system-initiated (45-day verification timeout). Check the reason field for system-initiated unenrollments.

**Unenrollment reasons**:
- **identity\_verification\_pending**: Identity verification was not completed within 45 days
- **identity\_verification\_rejected**: Identity verification was rejected
- **lease\_not\_uploaded**: Lease document was not uploaded within 45 days
- **lease\_rejected**: Lease document was rejected during verification
- **landlord\_pending**: Landlord verification was not completed within 45 days
- **landlord\_rejected**: Landlord verification was rejected
- **(absent)**: Manual unenrollment (customer or partner initiated) — reason field is omitted

**Payload: **
` { `
` "event": "customer_unenrolled", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` "reasons": ["identity_verification_pending"] `
` }` | | furnishment\_finished
| A rent payment was reported to a credit bureau for a specific month. Sent once per bureau per reporting cycle. Includes bureau name and rental\_verification details with the reported month and status.

**Payload:**
` { `
` "event": "furnishment_finished", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` "bureau": "experian", `
` "rental_verification": { `
` "id": "rv_ghi012", `
` "for_month": "2026-03-01", `
` "status": "pending_confirmation", `
` "months_delinquency": 0 `
` } `
` }` | | issue\_pending | An issue was detected with the enrollment that requires customer action (e.g., failed bank verification, lease mismatch). The customer has been notified.

**Payload:**
`{ `
` "event": "issue_pending", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` "slug": "bank_verification_failed", `
` "title": "Bank Verification Failed", `
` "description": "We were unable to verify your bank account. Please reconnect your bank." `
` }` | | issue\_resolved | A previously pending issue was resolved by the customer. The enrollment is back on track.

**Payload:**
` { `
` "event": "issue_resolved", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` "slug": "bank_verification_failed", `
` "title": "Bank Verification Failed", `
` "description": "We were unable to verify your bank account. Please reconnect your bank." `
` }` | | rental\_payment\_verified | A monthly rent payment was verified. Includes transaction details showing the matched bank transactions.

**Payload:**
` { `
` "event": "rental_payment_verified", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` "rental_verification_id": "rv_ghi012", `
` "for_month": "2026-03-01", `
` "transactions": [ `
` { `
` "name": "RENT PAYMENT", `
` "amount": 150000, `
` "source": "plaid", `
` "external_id": "txn_abc123" `
` } `
` ] `
` }`

Note: amount is in cents (e.g., 150000 = $1,500.00). | | enrollment\_verification\_verified | An enrollment verification step (identity, lease, or landlord) was approved. The kind field indicates which verification type.

**kind**: identity, lease, landlord
**review\_method**: automatic, manual

**Payload:**
`{ `
` "event": "enrollment_verification_verified", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` "verification_id": "ver_jkl012", `
` "kind": "lease", `
` "memo": "", `
` "review_method": "automatic" `
` }` | | enrollment\_verification\_rejected | An enrollment verification step was rejected. The kind field indicates which type, and memo may contain additional context.

**kind**: identity, lease, landlord
**review\_method**: automatic, manual

**Payload:**
`{ `
` "event": "enrollment_verification_rejected", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456", `
` "verification_id": "ver_jkl012", `
` "kind": "lease", `
` "memo": "", `
` "review_method": "automatic" `
` }`
| | enrollment\_moved\_out | The customer was marked as moved out of their rental unit. Reporting will stop for this enrollment.

**Payload: **
`{ `
` "event": "enrollment_moved_out", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "enrollment_id": "enr_def456" `
` }` | | boomreport\_plaid\_link\_visited | Sent when the customer visits the generated Plaid bank linking URL

**Payload:**
` { `
` "event": "boomreport_plaid_link_visited", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "customer_id": "cust_abc123", `
` "customer_first_name": "Jane", `
` "customer_last_name": "Doe", `
` "customer_email": "jane@example.com", `
` "customer_phone": "15551234567", `
` "customer_created_at": "2026-01-15T10:30:00Z" `
` }` | | boomreport\_plaid\_link\_requested | Sent when the customer clicks "copy" or "request" on their Plaid bank linking URL

**Payload:**
` { `
` "event": "boomreport_plaid_link_requested", `
` "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", `
` "plaid_connect_url": "https://cdn.plaid.com/link/v2/...", `
` "customer_id": "cust_abc123", `
` "customer_first_name": "Jane", `
` "customer_last_name": "Doe", `
` "customer_email": "jane@example.com", `
` "customer_phone": "15551234567", `
` "customer_created_at": "2026-01-15T10:30:00Z" `
` }` | ### Boom Screen Events | 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
created\_at
application\_updated\_at
external\_id | | 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
created\_at
application\_updated\_at
external\_id | | application\_canceled | Emitted in case application is canceled. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | application\_declined | Emitted in case application is declined. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | applicant\_submitted | Emitted in case applicant submitted. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | applicant\_started | Emitted in case applicant started. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | application\_submitted | Emitted in case application is submitted. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | application\_updated | Emitted in case application is updated. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | application\_started | Emitted in case application is started. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | applicant\_created | (Deprecated) Emitted in case applicant created. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id | | application\_created | (Deprecated) Emitted in case application created. | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at | | applicant\_completed | (Deprecated) 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
created\_at
application\_updated\_at
external\_id | | application\_completed | (Deprecated) 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
created\_at
application\_updated\_at
external\_id | | application\_merged

| Emittedin case applications are merged | event:
target\_application\_id:
target\_application\_url:
merged\_application\_ids:
merged\_at:
merged\_by: | | identity\_verification\_finished | When a lead or an applicant finish identity verification | event:
status:
lead\_id:
first\_name:
last\_name:
email:
phone:
identity\_verification\_finished:
external\_customer\_id:
created\_at:
updated\_at: application\_status:
applicant\_id:
application\_id:
role:
finished\_at:
| | identity\_verification\_expired | When an identity verification expires (30 days since it last finished) | event:
status:
lead\_id:
first\_name:
last\_name:
email:
phone:
identity\_verification\_finished:
external\_customer\_id:
created\_at:
updated\_at: application\_status:
applicant\_id:
application\_id:
role:
finished\_at: | | push\_applicants\_to\_property\_management\_system | When applicants are pushed to property management system | event:
dependents:
pets
first\_name
last\_name
phone
email
desired\_move\_in\_date
unit
address
monthly\_rent\_amount
status
created\_at
application\_updated\_at
external\_id
pms\_push\_status
error\_message | | `applicant_invite_followup` | Triggered after configurable delay when an invited applicant hasn't started their application. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | applicant\_identity\_followup | Triggered after configurable delay when an applicant hasn't completed identity verification. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | applicant\_income\_followup | Triggered after configurable delay when an applicant hasn't completed income verification. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | applicant\_checkout\_followup | Triggered after configurable delay when an applicant finished verifications but hasn't submitted. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | pet\_screening\_requested | Triggered when a pet screening is requested for an applicant. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | application\_under\_review | Triggered when a group application is submitted and enters review status. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | applicant\_receipt | Triggered when the application fee payment receipt email is sent. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | application\_decision\_reverted | Triggered when an application decision is reversed/undone. | event: lead\_id: invited\_lead: inviting\_applicant: dependents: pets: applicants: desired\_move\_in\_date: unit: unit\_object: property: monthly\_rent\_amount: status: portal\_url: id: reasons: created\_at: application\_updated\_at: external\_id: | | application\_assigned\_to\_user | Emitted when team members are assigned to or removed from an application. unassigned is true when no one was newly assigned. | event:
application\_id:
assigned\_users:
newly\_assigned\_users:
unassigned\_users:
assigned\_at:
unassigned: | ### Boom CRM Events | Event | Description | Other fields | | ------------------------ | -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | lead\_created | Emitted when a lead is created. | event:
lead\_id:
first\_name:
last\_name:
email:
phone:
source:
property\_id:
property\_name:
unit\_id:
unit\_name:
created\_at: | | lead\_assigned\_to\_user | Emitted when team members are assigned to or removed from a lead. unassigned is true when no one was newly assigned. | event:
lead\_id:
assigned\_users:
newly\_assigned\_users:
unassigned\_users:
assigned\_at:
unassigned: | | lead\_status\_changed | Emitted when a lead moves to a different pipeline stage. | event:
lead\_id:
previous\_stage\_id:
previous\_stage:
new\_stage\_id:
new\_stage:
property\_id:
property\_name:
unit\_id:
unit\_name:
changed\_at: | | showing\_requested | Emitted when a showing is booked. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at: | | showing\_scheduled | Emitted when the showing time is accepted by your team or confirmed automatically. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at:
confirmed\_at: | | showing\_confirmed | Emitted when the lead confirms they will attend a guided showing. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at:
lead\_confirmed\_at: | | showing\_checked\_in | Emitted when the lead checks in to a self-guided showing or is sent the lockbox code. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at:
checked\_in\_at: | | showing\_rescheduled | Emitted when a showing is moved to a new time. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at:
previous\_scheduled\_at:
previous\_end\_at:
rescheduled\_by:
rescheduled\_by\_user:
confirmed\_at: | | showing\_completed | Emitted when a showing is marked completed. Not emitted for no-shows. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at:
completed\_at: | | showing\_canceled | Emitted when a showing is canceled. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at:
originally\_scheduled\_at:
canceled\_at:
canceled\_by:
canceled\_by\_user: | | showing\_no\_show | Emitted when a showing is marked as a no-show. | event:
showing\_id:
lead\_id:
lead\_name:
property\_id:
property\_name:
unit\_id:
unit\_name:
showing\_type:
scheduled\_at:
status:
created\_at:
marked\_no\_show\_at: |