Connections

Oauth2 Callback

This callback/webhook is used while creating a new connection with Oauth2. See https://docs.peaka.com/how-to-guides/how-to-create-oauth2-based-connections-via-peaka for more information.

post/connections/{projectId}/oauth2

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/connections/{projectId}/oauth2
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the project

Request body

queryParametersstring

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

Connection created successfully

idstring

Connection ID

namestring

Name of the connection

typestring

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

urlstring

Oauth callback url if the connection is Oauth based.

Changes

No recorded changes to this operation across all 1 revision of this API.