POST
/
connections
/
{projectId}
/
oauth2
Oauth2 Callback
curl --request POST \
  --url https://partner.peaka.studio/api/v1/connections/{projectId}/oauth2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "queryParameters": "code=1234&state=xyz&param1=value1&param2=value2"
}'
{
  "id": "6243f42a-42d0-4821-a90f-763cda6cda50",
  "name": "exampleOauth2Connection",
  "type": "google_analytics"
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer <apiKey>' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the project

Body

application/json

Oauth2 Callback Body

​
queryParameters
string

Query parameters received from the Oauth2 redirection. Pass all query parameters as a single string.

Example: "https://yourdomain.com/oauth2/mycallback?code=1234&state=xyz&param1=value1&param2=value2"

"queryParameters": "code=1234&state=xyz&param1=value1&param2=value2"

Response

200 - application/json

Connection created successfully

​
id
string

Connection ID

​
name
string

Name of the connection

​
type
string

Type of connection.

Example: airtable for AirTable, stripe for Stripe, hubspot_access_token for HubSpot (with Access Token), etc.

Exact list can be fetched by following url: /connections/config

​
url
string

Oauth callback url if the connection is Oauth based.