Customer Events

The following webhook events are triggered during the customer lifecycle:

Customer Events

Event	Description
customer.created	Triggered when a new Customer is created after an application is approved.
customer.updated	Triggered when a Customer is updated (by the org or by Unit for sensitive fields).
customer.archived	Triggered when a Customer is archived.

Listening for Events

To receive these events, you need to set up a webhook endpoint. See the Webhooks documentation for more information on configuring webhooks.

Example Event Payload

When a customer is created, you will receive an event similar to:

{
  "data": [
    {
      "id": "28",
      "type": "customer.created",
      "attributes": {
        "createdAt": "2020-07-29T12:53:05.882Z",
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "customer": {
          "data": {
            "id": "52",
            "type": "individualCustomer"
          }
        },
        "application": {
          "data": {
            "id": "52",
            "type": "individualApplication"
          }
        }
      }
    }
  ]
}

Event Flow

1. customer.created - Customer created after application approval
2. customer.updated - Customer information is modified
3. customer.archived - Customer relationship ends