Skip to main content
Events represent activity that has occurred within Chart or within third-party tax providers. Your app can sync the data via either the events API or webhooks.

​
Event objects

All event objects share a similar structure.
AttributeDescription
eventA string that distinguishes the event type.
idUnique identifier for the event.
dataEvent payload.
created_atTimestamp of when the event occurred.

​
Taxpayer events

Events emitted when data about a taxpayer changes such as when a taxpayer’s status changes, a taxpayer is disconnected from a provider, or a taxpayer’s records are synced.
Taxpayer status changed event
{
    "event": "taxpayer.status_changed",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "taxpayer_id": "tx_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
        "status": "COMPLETED",
        "status_description": "Taxpayer completed the onboarding process",
        "provider_id": "turbotax"
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}
Taxpayer records synced event
{
    "event": "taxpayer.records_synced",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "taxpayer_id": "tx_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
        "provider_id": "turbotax"
        "records": [
            {
                "record_id": "record_id",
                "tax_year": 2021,
            }
        ]
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}
Taxpayer disconnected event
{
    "event": "taxpayer.disconnected",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "taxpayer_id": "tx_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
        "name": "John Doe",
        "provider_id": "turbotax"
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}

​
Widget events

Events emitted when end users (taxpayers) interact with Chart Connect widget.
Widget opened event
{
    "event": "widget.opened",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {},
    "created_at": "2021-08-17T03:29:59.397Z"
}
Widget closed event
{
    "event": "widget.closed",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {},
    "created_at": "2021-08-17T03:29:59.397Z"
}
Widget failed event
{
    "event": "widget.failed",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "error": {
            "code": "provider_timeout",
            "message": "Provider timed out."
        }
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}
Events emitted when end users (taxpayers) interact with the no-code client links.
⌘I