Events - AltScore Docs

The Webhook Event Object

The Webhook Event object represents a notification sent to the configured webhook URL. It is the exact body of the POST request your endpoint receives.

Every delivery is signed with the svix-id, svix-timestamp and svix-signature headers. Verify the signature against the raw body before processing it: otherwise you cannot tell this event apart from a forged POST. The procedure is described in the Webhooks guide.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": "cms.client.change.status",
  "timestamp": "2024-09-30T21:04:33.425154424Z",
  "entityType": "cms.client.status.updated",
  "version": "20240901",
  "data": {
    "entity": {
      "address": "123 Main St, Anytown, AN 12345",
      "clientId": "987f6543-c21a-4b87-912c-987654321000",
      "createdAt": "2024-06-12T21:48:52.001Z",
      "dba": "ACME CORPORATION",
      "emailAddress": "contact@example.com",
      "externalId": "ACME001",
      "isEmailVerified": true,
      "isPhoneVerified": false,
      "legalName": "Acme Inc.",
      "partnerId": "246f8135-a975-4ed1-8b9c-123456789000",
      "phoneNumber": "1234567890",
      "status": "active",
      "taxId": "AB-1234567",
      "updatedAt": "2024-06-12T21:48:52.001Z"
    }
  },
  "actor": {
    "id": "user-135",
    "actorType": "system"
  }
}

Event Attributes

Attribute	Description	Type
`id`	Unique identifier of the event	String
`event`	Type of event (e.g. "cms.client.change.status")	String
`timestamp`	Date and time of the event (ISO 8601 format)	String
`entityType`	Type of entity related to the event	String
`version`	Version of the event format	String
`data`	Specific data of the event	Object
`data.entity`	Body of the entity related to the event	Object
`actor`	Information about the actor that triggered the event	Object
`actor.id`	Identifier of the actor	String
`actor.actorType`	Type of actor	String

Available Events

Borrower Central Events

Borrower Updated (bc.borrower.updated): Indicates that a borrower's information has been updated. data.entity is a borrower object.

CMS Events

Debt Events

Debt Due (cms.debt.due): Active debt.
Debt Overdue (cms.debt.overdue): Active debt that has passed its due date.
Debt Paid (cms.debt.paid): Triggered when a payment has been recorded on a debt.
Debt Created (cms.debt.created): Generated when a new debt is created.
Debt Closed (cms.debt.closed): Triggered when a debt has been closed.

For all debt events, data.entity is a debt object.

Note: The events cms.debt.due and cms.debt.overdue are triggered twice a day, at 03:42 and 15:42 UTC. That is, for each active debt, at least two notifications are sent per day.

Client Events

CMS Client Updated (cms.client.updated): Indicates that a CMS client has been updated.
CMS Client Status Updated (cms.client.status.updated): Indicates that the status of a CMS client has changed.

For client events, data.entity is a client object.

Credit Line Events

Credit Line Updated (cms.credit_account.credit_line.updated): Triggered when the credit line is updated.
Credit Line Reserved (cms.credit_account.credit_line.reserved): Indicates that a credit line has been reserved.
Credit Line Committed (cms.credit_account.credit_line.committed): Indicates that a credit line has been committed.
Credit Line Released (cms.credit_account.credit_line.released): Triggered when a credit line has been released.

For all credit line events, data.entity is a credit-account object.

Disbursement Account Events

Disbursement Account Status Updated (cms.disbursement.account.status.changed): Triggered when the status of a disbursement account changes.
Disbursement Account Updated (cms.disbursement.account.update): Triggered when a disbursement account is updated.

For disbursement account events, data.entity is a Disbursement Account object.

The entity type for these events is cmd.disbursement.account.

Payment Events

Payment Received (cms.payment.received): Triggered when a new payment is received in the system.

For payment events, data.entity is a Payment object.

The entity type for these events is cms.payment.

On this page