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

# connect_integration

> **Connect integration**

Create a requester-only authorization link for Zendesk, Intercom, Slack ingestion, Gong, or Salesforce. Use only after the user requests the connection; get_integration_state confirms the destination workspace and supported providers. Reuse an already authenticated connection when it is the one the user wants. For Gong, the user enters the access key, access secret, and subdomain in the browser form.

For Salesforce, confirm Service Cloud, Sales Cloud, or both and whether this is a sandbox. Pass serviceCloud and salesCloud explicitly; isSandbox true uses sandbox login. Salesforce is available only for enabled PLG or hybrid workspaces. Authorization does not select which objects to import.

Clients supporting URL elicitation display an authorization prompt outside the model conversation. After the user continues, this call verifies the same stored request. If authorizationMode is url_elicitation, do not claim that no prompt appeared because it is absent from the transcript. Otherwise, show authorizationUrl and ask the user to open it. They must sign into the same Rippit account, review the destination workspace, and authorize the provider in the browser. Never ask for passwords, API keys, access tokens, or authorization codes in chat. This authorizes data access only; importing is a separate step. For Slack, the bot can read only channels it has access to; ask the user to add it to the channels they want imported.

Retain request.id. After the 30-minute native prompt window expires, the transport returns url_elicitation_expired and the original requestId; if the client does not resume, tell the user to return and say Done, then check that exact request with get_integration_state rather than creating another. Do not create another link while one is pending unless the user requests a replacement.



## OpenAPI

````yaml /api-reference/tools-openapi.json post /v1/connect_integration
openapi: 3.1.0
info:
  title: Rippit API
  version: 1.0.0
  description: Every operation is also an MCP tool with the same name and parameters.
servers:
  - url: https://api.rippit.com
security:
  - bearer: []
paths:
  /v1/connect_integration:
    post:
      summary: connect_integration
      description: >-
        **Connect integration**


        Create a requester-only authorization link for Zendesk, Intercom, Slack
        ingestion, Gong, or Salesforce. Use only after the user requests the
        connection; get_integration_state confirms the destination workspace and
        supported providers. Reuse an already authenticated connection when it
        is the one the user wants. For Gong, the user enters the access key,
        access secret, and subdomain in the browser form.


        For Salesforce, confirm Service Cloud, Sales Cloud, or both and whether
        this is a sandbox. Pass serviceCloud and salesCloud explicitly;
        isSandbox true uses sandbox login. Salesforce is available only for
        enabled PLG or hybrid workspaces. Authorization does not select which
        objects to import.


        Clients supporting URL elicitation display an authorization prompt
        outside the model conversation. After the user continues, this call
        verifies the same stored request. If authorizationMode is
        url_elicitation, do not claim that no prompt appeared because it is
        absent from the transcript. Otherwise, show authorizationUrl and ask the
        user to open it. They must sign into the same Rippit account, review the
        destination workspace, and authorize the provider in the browser. Never
        ask for passwords, API keys, access tokens, or authorization codes in
        chat. This authorizes data access only; importing is a separate step.
        For Slack, the bot can read only channels it has access to; ask the user
        to add it to the channels they want imported.


        Retain request.id. After the 30-minute native prompt window expires, the
        transport returns url_elicitation_expired and the original requestId; if
        the client does not resume, tell the user to return and say Done, then
        check that exact request with get_integration_state rather than creating
        another. Do not create another link while one is pending unless the user
        requests a replacement.
      operationId: connect_integration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  oneOf:
                    - type: object
                      properties:
                        source:
                          type: string
                          const: zendesk
                        subdomain:
                          type: string
                          minLength: 1
                          pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
                          description: Zendesk subdomain without .zendesk.com.
                      required:
                        - source
                        - subdomain
                      additionalProperties: false
                    - type: object
                      properties:
                        source:
                          type: string
                          const: intercom
                        regionCode:
                          type: string
                          enum:
                            - us
                            - eu
                            - au
                          description: Intercom data hosting region.
                      required:
                        - source
                        - regionCode
                      additionalProperties: false
                    - type: object
                      properties:
                        source:
                          type: string
                          const: slack_ingest
                      required:
                        - source
                      additionalProperties: false
                    - type: object
                      properties:
                        source:
                          type: string
                          const: gong
                      required:
                        - source
                      additionalProperties: false
                    - type: object
                      properties:
                        source:
                          type: string
                          const: salesforce
                        serviceCloud:
                          type: boolean
                          description: >-
                            Enable Service Cloud and verify read access to
                            Cases.
                        salesCloud:
                          type: boolean
                          description: >-
                            Enable Sales Cloud and verify read access to
                            Opportunities.
                        isSandbox:
                          description: >-
                            True for a Salesforce sandbox; omitted or false uses
                            production login.
                          type: boolean
                      required:
                        - source
                        - serviceCloud
                        - salesCloud
                      additionalProperties: false
                  description: >-
                    Provider the user asked to connect to the displayed Rippit
                    workspace.
              required:
                - provider
              additionalProperties: false
      responses:
        '200':
          description: Tool result.
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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