Events

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.

Attribute	Description
event	A string that distinguishes the event type.
id	Unique identifier for the event.
data	Event payload.
created_at	Timestamp 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

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

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

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"
}

Events emitted when end users (taxpayers) interact with Chart Connect widget.

widget.opened

widget.closed

widget.failed

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"
}

Client Link events

Events emitted when end users (taxpayers) interact with the no-code client links.

client_link.opened

Client link opened event

{
    "event": "client_link.opened",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "url": "https://dashboard.trychart.com/c/test"
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}

client_link.closed

Client link closed event

{
    "event": "client_link.closed",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "url": "https://dashboard.trychart.com/c/test"
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}

client_link.failed

Client link failed event

{
    "event": "client_link.failed",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "error": {
            "code": "provider_timeout",
            "message": "Provider timed out."
        }
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}

client_link.succeeded

Client link succeeded event

{
    "event": "client_link.succeeded",
    "id": "ev_1bxJqfif_-EJjbl9DNwilJCt5D2tC5Q5",
    "data": {
        "provider_id": "turbotax"
    },
    "created_at": "2021-08-17T03:29:59.397Z"
}

How Chart Works

Implementation Guide

Developer Resources

Event objects

Taxpayer events

Widget events

Client Link events

How Chart Works

Implementation Guide

Developer Resources

​Event objects

​Taxpayer events

​Widget events

​Client Link events

Event objects

Taxpayer events

Widget events

Client Link events