Webhook glossary

Mass payment file process is completed

If you have uploaded a file for bulk payments, it takes some time to process the file. Rather than waiting for this process to complete and rechecking its status, you can subscribe to a real time notification about this event via this webhook.

Example

{
  "eventName": "mass_payment_file_processed",
  "data": {
    "processed": true
  }
}

Mass sending of the payments is completed

Once your mass payment file is processed, you can send all valid payments. With this webhook, you can subscribe to the asynchronous result of your mass payment. Once all valid payments are sent, this webhook will trigger.

Example

{
  "eventName": "mass_payments_sent",
  "data": {
    "sent": true
  }
}

Payment status changed

When you send a payment, a new payment is created with an initial status, like Awaiting-cash-out. This status will be changed depending on what event is currently taking place for his payment. When the status of this payment changes, the webhook for this event will be launched for the sender and recipient of this payment. It contains basic information: id, from, to, amount and status.

Example

{
  "eventName": "payment_status_changed",
  "data": {
    "id": 1,
    "from": "[email protected]",
    "to": "[email protected]",
    "amount": 12.34,
    "status": "Awaiting-cash-out"
  }
}

Invoice status changed

When you create an invoice, it is assigned an initial status that changes as the invoice moves through its lifecycle (for example, when a payment link is sent or the invoice is paid). Whenever the status of one of your invoices changes, this webhook fires with the full invoice details, including the related policyholder, carrier, and MGA. The status field is the human-readable invoice status name (for example, direct_payment_paid).

📘

Status format

The readable status name is being rolled out. Until that change is fully deployed, the status field may instead arrive as the numeric status code as a string (for example, "12" for direct_payment_paid). We recommend handling both formats during the transition.

Example

{
  "eventName": "invoice_status",
  "data": {
    "id": "1",
    "status": "direct_payment_paid",
    "grossPremium": 1000,
    "commission": 100,
    "netPremium": 900,
    "policyId": "POL-12345",
    "brokerCode": "BRK-001",
    "effectiveDate": "2026-01-01T00:00:00.000Z",
    "expirationDate": "2027-01-01T00:00:00.000Z",
    "stripeSubscriptionId": null,
    "policyholder": {
      "email": "[email protected]",
      "firstName": "Jane",
      "lastName": "Doe",
      "businessName": null
    },
    "carrier": {
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Smith",
      "businessName": null
    },
    "mga": null
  }
}

Account verification status changed

The onboarding process for verified users in ClaimsSnap an asynchronous KYB process. This webhook lets you subscribe to your account verification status in real time after you've signed up and submitted your information for verification.

Example

{
  "eventName": "verification_status_changed",
  "data": {
    "status": "verified"
  }
}

Beneficial owners status changed

If you are an organization, you will need to go through an additional verification process after confirming your account. Depending on your entity circumstances, you may need to verify beneficial owners that hold significant equity in your business.

This webhook lets you subscribe to the status of beneficial ownership validation for your account.

Example

{
  "eventName": "bo_status_changed",
  "data": {
    "status": "certified"
  }
}