connection.completed

This event is emitted when a user successfully completes the authentication process. This can occur either by creating a new connection or by merging with an existing connection to avoid duplicates. Subscribing to this event allows you to receive details of any successful authentication along with the resulting connection information.

string

required

type

enum<string>

required

Available options:

connection.completed

timestamp

string

required

ISO 8601 date

detail

object

required

detail.metadata

object

required

Data passed during authentication, excluding existing connection details.

detail.connection

object

required

The latest authenticated connection details, including merged information.

detail.connection.id

string

required

detail.connection.company

object

required

detail.connection.status

enum<string>

required

Enum values:

connected: active and authenticated connection
disconnected: connection is no longer authenticated - please ask your user to link the account again
archived: connection has been archived from view - attempts to re-connect will cause us to check the connection status again

Available options:

connected,

disconnected,

archived,

pending_deletion

detail.connection.provider

object

required

detail.connection.syncMode

enum<string>

default: automaticrequired

Enum values:

automatic: Terminal will keep this connections data up to date
manual: Terminal will only sync data upon request

Available options:

automatic,

manual

detail.connection.token

string

required

This token is used when interacting with a connections' data.

detail.connection.createdAt

string

required

ISO 8601 date

detail.connection.updatedAt

string

required

ISO 8601 date

detail.connection.externalId

string

An optional ID from your system that can be used to reference connections.

detail.connection.sourceId

string

The ID used in the source system to represent the account this connection has access to.

This may be an organizationId or accountId.

Note: not all systems expose this information, in which case it may be undefined.

detail.connection.tags

string[]

An optional list of tags from your system that can be used to reference connections.

detail.connection.linkUrl

string

The URL to send your user to in order to have them re-authenticate the connection.

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

connection.completed