Create connect session

http
POST /projects/{project_reference}/integrations/{name}/connect-sessions

Create connect session.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYes
namepathYes

Parameter contracts

json
[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "description": "Project ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not_found."
    },
    "required": true,
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "description": "Integration name, for example github or slack."
    },
    "required": true,
    "name": "name",
    "in": "path"
  }
]

Request body

json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "scope": {
            "type": "string",
            "enum": [
              "user",
              "project"
            ],
            "description": "Connection owner. Project scope needs the editor role; user scope connects your own account and needs viewer access to the project. API keys also need the integrations write scope. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused."
          },
          "redirect_uri": {
            "type": "string",
            "maxLength": 4096,
            "description": "Trusted web or native URI the browser returns to after consent."
          }
        },
        "required": [
          "scope",
          "redirect_uri"
        ],
        "additionalProperties": false
      }
    }
  }
}

Responses

201

One-time provider consent link.

json
{
  "description": "One-time provider consent link.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ConnectSession"
      },
      "example": {
        "session_token": "ocs_example",
        "connect_url": "https://api.veryfront.com/oauth/connect/github?session_token=ocs_example",
        "expires_at": "2026-10-10T12:05:00.000Z"
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Project or connection not found, including inaccessible projects or denied scope-dependent project access.

json
{
  "description": "Project or connection not found, including inaccessible projects or denied scope-dependent project access.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

429

Rate limit exceeded

json
{
  "description": "Rate limit exceeded",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

503

Service unavailable

json
{
  "description": "Service unavailable",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/schemas/ConnectSession

json
{
  "type": "object",
  "properties": {
    "session_token": {
      "type": "string",
      "description": "One-time connect session token, embedded in connect_url."
    },
    "connect_url": {
      "type": "string",
      "description": "URL to open in a browser. It starts provider consent through GET /oauth/connect/{integration}.",
      "example": "https://api.veryfront.com/oauth/connect/github?session_token=ocs_example"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "UTC time (RFC 3339) after which connect_url no longer starts consent."
    }
  },
  "required": [
    "session_token",
    "connect_url",
    "expires_at"
  ]
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "createConnectSession",
  "tags": [
    "integrations/Connections/Connections"
  ],
  "summary": "Create connect session",
  "description": "Create connect session.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Project ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not_found."
      },
      "required": true,
      "name": "project_reference",
      "in": "path"
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "description": "Integration name, for example github or slack."
      },
      "required": true,
      "name": "name",
      "in": "path"
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "scope": {
              "type": "string",
              "enum": [
                "user",
                "project"
              ],
              "description": "Connection owner. Project scope needs the editor role; user scope connects your own account and needs viewer access to the project. API keys also need the integrations write scope. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused."
            },
            "redirect_uri": {
              "type": "string",
              "maxLength": 4096,
              "description": "Trusted web or native URI the browser returns to after consent."
            }
          },
          "required": [
            "scope",
            "redirect_uri"
          ],
          "additionalProperties": false
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "One-time provider consent link.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ConnectSession"
          },
          "example": {
            "session_token": "ocs_example",
            "connect_url": "https://api.veryfront.com/oauth/connect/github?session_token=ocs_example",
            "expires_at": "2026-10-10T12:05:00.000Z"
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Project or connection not found, including inaccessible projects or denied scope-dependent project access.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "503": {
      "description": "Service unavailable",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Connections",
  "x-canonical-documentation": {
    "domain": "integrations",
    "resource": "Connections",
    "subgroup": "Connections",
    "name": "Create connect session",
    "description": "Create connect session.",
    "operationId": "createConnectSession"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/integrations-connections-connections/create-connect-session"
  }
}