POpolytomic
Connections

Connect

Changed on

Creates a Polytomic Connect session and returns a URL for creating or reconnecting a Connection.

Open the returned URL, or send it to the person who will set up the Connection. Polytomic Connect guides them through authentication and configuration, then redirects them to redirect_url.

Each session can create or reconnect one Connection.

See also:

  • Embedding authentication, a guide to using Polytomic Connect.
post/api/connections/connect/

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Headers

X-Polytomic-Versionstring

Request body

connectionstring uuid

The id of an existing connection to update

darkboolean

Whether to use the dark theme for the Connect modal

namestring required

Name of the new connection. Must be unique per organization.

organization_idstring uuid nullable

Ignored for user and organization-scoped API keys, which always act in their own organization

redirect_urlstring

URL to redirect to after the hosted Connect flow finishes. Required for hosted Connect; omit it to mint a session for the embedded form (@polytomic/connect-react).

ttlinteger nullable

Connect session lifetime in seconds. Defaults to 300 and cannot exceed 604800.

typestring

Connection type to create

use_organization_nameboolean

Whether to display the target organization name instead of the partner name in the Connect modal. Defaults to false; organizations without a partner always display their organization name.

whiteliststring[] nullable

List of connection types which are allowed to be created. Ignored if type is set. The embedded form shows one connection type, so send exactly one entry.

Example request

{
  "connection": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "name": "Salesforce Connection",
  "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "ttl": 300,
  "type": "salesforce"
}

Response

OK

Example response

{
  "data": {
    "redirect_url": "https://app.polytomic.com/polytomic-connect?token=token",
    "token": "token"
  }
}

Changes

  • a53f421f2671Revision changes
    • info

      the request property became optional

  • d80b0fdea14eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status