> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Turn on a table's live changes

> Have the app send the table its changes as they happen: a webhook URL whose records land in the table's imported-record column and merge with the rows a refresh brings, through the table's own connection. When the app is told about the URL by Oneprofile (source.pastes_url false) nothing else is needed; otherwise the answer shows the URL in full this once, to paste into the app (reveal shows it again). Turning on what is on changes nothing. Only a signed-in person sees a URL; for the AI Assistant it is left out and shown on the table's Source panel.



## OpenAPI

````yaml /openapi.json put /tables/{table_id}/live-changes/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's spend threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: >-
      The approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for listing, checking and deleting integrations.
    name: integrations
  - description: >-
      Create, preview and update an integration of any type: the body's
      integration_type picks the config and credentials it takes.
    name: integration-specific
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: >-
      AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any
      other MCP client a person signed in to Oneprofile's MCP server with.
    name: ai_apps
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: >-
      Accounts: every company the workspace's tables name, with the people at
      it, its key facts, its tables, its org chart and what went to its people;
      the tables that feed it (Sources) and the merges a person made.
    name: accounts
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for an agent's Preview: example rows run one at a time, and a
      Looks good on each. Needs work lives under agent-learnings.
    name: agent-training
  - description: >-
      An agent's learnings, the one-line rules it follows on every output, and
      the thumbs down that teaches them: give one with what was wrong, list the
      ones on a subject, Undo one, and price the redo it would run.
    name: agent-learnings
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for the webhook URL an app or a tool of your own sends records
      to: what can send them, make the URL, show it again, replace it, revoke
      it, save the app's secrets, resume a paused feed, and read and retry the
      deliveries that did not fit.
    name: table-webhooks
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalogue endpoint behind the picker
      that builds them.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for recording where a new workspace came from: the marketing
      page or campaign its signup link carried, sent once after signup.
    name: attribution
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context (company description,
      ideal customer profile, buyer personas, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /tables/{table_id}/live-changes/:
    put:
      tags:
        - table-webhooks
      summary: Turn on a table's live changes
      description: >-
        Have the app send the table its changes as they happen: a webhook URL
        whose records land in the table's imported-record column and merge with
        the rows a refresh brings, through the table's own connection. When the
        app is told about the URL by Oneprofile (source.pastes_url false)
        nothing else is needed; otherwise the answer shows the URL in full this
        once, to paste into the app (reveal shows it again). Turning on what is
        on changes nothing. Only a signed-in person sees a URL; for the AI
        Assistant it is left out and shown on the table's Source panel.
      operationId: turn_on_table_live_changes
      parameters:
        - in: path
          name: table_id
          required: true
          schema:
            format: uuid
            title: Table Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveChangesTurnedOnSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Table not found, or no app imports into it.
        '422':
          description: >-
            The app sends no webhook for these records, the rows are matched on
            another field than the app's record ID, or the connection could not
            say which account it is.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Webhook URLs can't be made right now.
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    LiveChangesTurnedOnSchema:
      description: >-
        Live changes just turned on, with the URL to paste into the app when it
        needs one.
      properties:
        endpoint:
          anyOf:
            - $ref: '#/components/schemas/WebhookEndpointReadSchema'
            - type: 'null'
          description: >-
            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:
          description: The connection the table imports from.
          format: uuid
          title: Integration Id
          type: string
        integration_type:
          description: Its app.
          title: Integration Type
          type: string
        'on':
          description: >-
            Whether live changes are on: the app's changes reach the table as
            they happen, besides its refreshes.
          title: 'On'
          type: boolean
        reconnect_needed:
          description: >-
            Whether the app refused the connection when the webhook was
            registered or checked: reconnect the app with permission to manage
            webhooks.
          title: Reconnect Needed
          type: boolean
        record_type:
          description: The kind of record the table imports.
          title: Record Type
          type: string
        source:
          anyOf:
            - $ref: '#/components/schemas/WebhookSourceReadSchema'
            - type: 'null'
          description: >-
            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:
          format: uuid
          title: Table Id
          type: string
        unavailable:
          anyOf:
            - $ref: '#/components/schemas/LiveChangesUnavailable'
            - type: 'null'
          description: >-
            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.
        url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The URL to paste into the app, shown in full only here and by
            reveal, when you paste it into the app (source.pastes_url). Null
            when Oneprofile registers it, when the app's own webhook already
            reaches the connection, and when the AI Assistant or an AI app
            turned them on.
          title: Url
      required:
        - table_id
        - integration_id
        - integration_type
        - record_type
        - 'on'
        - unavailable
        - source
        - reconnect_needed
        - endpoint
        - url
      title: LiveChangesTurnedOnSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    WebhookEndpointReadSchema:
      description: >-
        A table's webhook URL and what it has received. Never the URL itself:
        reveal shows it.
      properties:
        authentication:
          $ref: '#/components/schemas/WebhookAuthentication'
          description: >-
            unsigned when the key in the URL is the only proof a delivery is the
            app's; signed when the app also signs each one. Fixed when the URL
            is made.
        created_at:
          format: date-time
          title: Created At
          type: string
        delivered_last_24h:
          description: Deliveries taken in the last 24 hours.
          title: Delivered Last 24H
          type: integer
        delivered_total:
          description: Deliveries taken, ever.
          title: Delivered Total
          type: integer
        failed_last_24h:
          description: Deliveries that did not fit in the last 24 hours.
          title: Failed Last 24H
          type: integer
        failed_total:
          description: Deliveries that did not fit, ever.
          title: Failed Total
          type: integer
        id:
          format: uuid
          title: Id
          type: string
        integration_type:
          description: The app that sends to it.
          title: Integration Type
          type: string
        key_hint:
          description: The first characters of the URL's key, to tell URLs apart.
          title: Key Hint
          type: string
        last_delivery_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the last delivery came.
          title: Last Delivery At
        last_silence_notice_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When you were last told deliveries had stopped.
          title: Last Silence Notice At
        last_test_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the app last sent a test delivery.
          title: Last Test At
        last_unsigned_surge_notice_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When you were last told of an unusual burst of new records.
          title: Last Unsigned Surge Notice At
        mechanism_key:
          description: Which of the app's deliveries it takes.
          title: Mechanism Key
          type: string
        old_key_expires_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            Until when the key a new one replaced still works; null when it does
            not.
          title: Old Key Expires At
        rejected_total:
          description: >-
            Deliveries refused because they did not prove they came from the
            app, ever.
          title: Rejected Total
          type: integer
        revoked_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When it was revoked; null while active.
          title: Revoked At
        status:
          $ref: '#/components/schemas/WebhookEndpointStatus'
          description: active while it takes deliveries; revoked once it answers none.
        subscription:
          anyOf:
            - $ref: '#/components/schemas/WebhookSubscriptionReadSchema'
            - type: 'null'
          description: >-
            Its registration with the app, when Oneprofile registers the URL
            through a connection; null when you paste the URL into the app
            yourself.
        table_id:
          format: uuid
          title: Table Id
          type: string
      required:
        - id
        - table_id
        - integration_type
        - mechanism_key
        - status
        - authentication
        - key_hint
        - old_key_expires_at
        - delivered_total
        - failed_total
        - rejected_total
        - delivered_last_24h
        - failed_last_24h
        - last_delivery_at
        - last_test_at
        - last_silence_notice_at
        - last_unsigned_surge_notice_at
        - created_at
        - revoked_at
      title: WebhookEndpointReadSchema
      type: object
    WebhookSourceReadSchema:
      description: >-
        One kind of webhook a table can be fed by: an app's deliveries, or any
        JSON.
      properties:
        columns:
          description: >-
            The columns the table gets besides its record column, in order.
            Empty when the fields are known only once deliveries arrive (any
            JSON).
          items:
            $ref: '#/components/schemas/WebhookSourceColumnReadSchema'
          title: Columns
          type: array
        customer_secrets:
          description: >-
            The secrets you copy from the app into the table's Source panel
            before its deliveries are accepted: signing_secret, the key it signs
            each delivery with; static_token, a token it sends with each one;
            verify_token, the token it checks the URL with. Empty when none.
          items:
            $ref: '#/components/schemas/WebhookSecretKind'
          title: Customer Secrets
          type: array
        display_name:
          description: What it is called; also the name of the table's record column.
          title: Display Name
          type: string
        integration_type:
          description: >-
            The app that sends it, as the integration types list names it;
            webhook for any JSON a tool of your own sends.
          title: Integration Type
          type: string
        mechanism_key:
          description: Which of the app's deliveries it is.
          title: Mechanism Key
          type: string
        pastes_url:
          default: true
          description: >-
            Whether you paste the URL into the app yourself (setup_guide_section
            says where), with any customer_secrets saved on the webhook. True
            for every source that does not subscribe, and for one that
            subscribes the connection but keeps the URL in your own app, such as
            Facebook Lead Ads.
          title: Pastes Url
          type: boolean
        plan_note:
          description: Which plan of the app sends webhooks; empty when any does.
          title: Plan Note
          type: string
        record_id_field:
          default: id
          description: >-
            The field naming each record in the app, such as id, or response_id
            for Typeform. A table imported from the app takes live changes only
            while its rows are matched on it.
          title: Record Id Field
          type: string
        record_type:
          description: The kind of record each delivery holds.
          title: Record Type
          type: string
        setup_guide_section:
          description: >-
            The section of the app's setup guide that says what to do in the
            app; empty when the guide has none.
          title: Setup Guide Section
          type: string
        subscribes:
          default: false
          description: >-
            Whether Oneprofile registers the URL with the app itself, through a
            connection to it: a URL of this kind is made with that connection's
            integration_id. Unless pastes_url is also true, you paste nothing
            into the app.
          title: Subscribes
          type: boolean
        takes_identity_path:
          description: >-
            Whether you name the field that tells rows apart (identity_path).
            When false the app's own record id does.
          title: Takes Identity Path
          type: boolean
      required:
        - integration_type
        - mechanism_key
        - display_name
        - record_type
        - columns
        - takes_identity_path
        - plan_note
        - setup_guide_section
        - customer_secrets
      title: WebhookSourceReadSchema
      type: object
    LiveChangesUnavailable:
      description: Why a table imported from an app cannot have live changes turned on.
      enum:
        - not_offered
        - rows_not_matched_by_id
      title: LiveChangesUnavailable
      type: string
    WebhookAuthentication:
      description: >-
        What proves a delivery came from the app, fixed when the URL is made.


        unsigned: the key in the URL is the only proof. signed: the app also
        signs each delivery.
      enum:
        - signed
        - unsigned
      title: WebhookAuthentication
      type: string
    WebhookEndpointStatus:
      description: 'Whether a webhook URL takes deliveries: active, or revoked for good.'
      enum:
        - active
        - revoked
      title: WebhookEndpointStatus
      type: string
    WebhookSubscriptionReadSchema:
      description: >-
        How the URL is registered with the app, for an app Oneprofile tells
        about it.
      properties:
        error:
          anyOf:
            - $ref: '#/components/schemas/WebhookSubscriptionError'
            - type: 'null'
          description: >-
            Why it last failed: refused (the connection may not manage
            webhooks), connection_gone, vendor_unavailable, not_signed (the app
            gave no signing secret), setup_incomplete (the connection lacks a
            setting it needs, such as Facebook's Page ID) or missing (the app
            lost it, so it was registered again). Null when it did not.
        error_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When it last failed.
          title: Error At
        last_checked_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the app last confirmed the registration.
          title: Last Checked At
        status:
          $ref: '#/components/schemas/WebhookSubscriptionStatus'
          description: >-
            pending while it is being registered; active once the app sends to
            it; disabled when the app turned it off; failed when it could not be
            registered (error says why); deleting and then deleted once the URL
            is revoked.
      required:
        - status
        - last_checked_at
        - error
        - error_at
      title: WebhookSubscriptionReadSchema
      type: object
    WebhookSourceColumnReadSchema:
      description: A column a table fed by this kind of webhook gets when its URL is made.
      properties:
        display_name:
          description: The column's name in the table.
          title: Display Name
          type: string
        name:
          description: The record field the column reads.
          title: Name
          type: string
        type:
          $ref: '#/components/schemas/PropertyType'
          description: What the column holds.
      required:
        - name
        - display_name
        - type
      title: WebhookSourceColumnReadSchema
      type: object
    WebhookSecretKind:
      description: What a webhook secret is for.
      enum:
        - signing_secret
        - static_token
        - verify_token
      title: WebhookSecretKind
      type: string
    WebhookSubscriptionError:
      description: >-
        Why a registration failed or a check could not tell; a code, never a
        vendor message.
      enum:
        - refused
        - connection_gone
        - vendor_unavailable
        - not_signed
        - setup_incomplete
        - missing
      title: WebhookSubscriptionError
      type: string
    WebhookSubscriptionStatus:
      description: Where an endpoint's registration with the vendor stands.
      enum:
        - pending
        - active
        - disabled
        - failed
        - deleting
        - deleted
      title: WebhookSubscriptionStatus
      type: string
    PropertyType:
      description: Type of a property. Used while creating/updating/deleting properties.
      enum:
        - string
        - integer
        - float
        - boolean
        - datetime
        - date
        - list
        - dict
      title: PropertyType
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.