integrations

Connect Salesforce with a customer Connected App

Connect a Salesforce org using a customer-created Connected App (client-credentials flow, no OAuth).

post/v1/integrations/salesforce/connect

Request body

client_idstring required

Connected App consumer key

client_secretstring required

Connected App consumer secret

my_domain_urlstring required

The org's My Domain URL (https://<domain>.my.salesforce.com)

store_namestring nullable

Ingestion store name. A store that already exists is shared: every data source connected to it ingests into it, except another installation of the same account, which would ingest every item again. Without it, the account's default store, numbered past a store another installation of the account feeds. Rejected with 422 when the connect refreshes an existing installation and names a store other than its own.

new_storeboolean

Ingest into a store created for this connection: the connect fails with 409 when store_name names a store that already exists, and without store_name the default name is numbered past existing stores. Rejected with 422 when the connect refreshes an existing installation, which keeps its store.

sync_schedule_interval'off' | 'ten_minutes' | 'hourly' | 'daily' | 'weekly'

Initial periodic sync interval

Response

The connected Salesforce installation

Changes

Changed in 4 of the 30 revisions of this API.55

    • ○

      added the new optional request property

      new-optional-request-property

    • ●

      added the new bucket_unavailable_error enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new bucket_unavailable_error enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new store_frozen_error enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new store_frozen_error enum value to the / response property for the response status

      response-property-enum-value-added

  • adde8ecfa74f14See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog