Skip to main content
GET
Get a table's live changes

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Response

Successful Response

Whether a table imported from an app takes the app's changes as they happen.

endpoint
WebhookEndpointReadSchema · object | null
required

The URL the changes arrive at while live changes are on (what it received, its registration with the app); null while they are off.

integration_id
string<uuid>
required

The connection the table imports from.

integration_type
string
required

Its app.

on
boolean
required

Whether live changes are on: the app's changes reach the table as they happen, besides its refreshes.

reconnect_needed
boolean
required

Whether the app refused the connection when the webhook was registered or checked: reconnect the app with permission to manage webhooks.

record_type
string
required

The kind of record the table imports.

source
WebhookSourceReadSchema · object | null
required

The app's webhook live changes use. subscribes says Oneprofile registers it with the app; pastes_url says you paste the URL into the app (setup_guide_section) and save any customer_secrets. Null when the app sends none.

table_id
string<uuid>
required
unavailable
enum<string> | null
required

Why live changes can't be turned on: not_offered (the app sends no webhook for these records), rows_not_matched_by_id (rows are matched on another field than the app's record ID: change the import's identity_field to the source's record_id_field first). Null when they can be, or are on.

Available options:
not_offered,
rows_not_matched_by_id