Skip to content

Popup-aware OAuth callback (Plan 209-02)

GET
/api/v1/connectors/{slug}/oauth/callback
curl --request GET \
--url 'https://api.ultimateteam.ai/api/v1/connectors/example/oauth/callback?ui=popup' \
--header 'X-API-Key: <X-API-Key>'

Handles the OAuth provider redirect for both popup and fullpage flows. Performs atomic rollback so a failed token exchange leaves no orphan connector row. Returns popup HTML (for ?ui=popup) or RedirectResponse to /settings/connectors (for ?ui=fullpage).

slug
required
Slug
string
code
Any of:
string
state
Any of:
string
ui
Ui
string
default: fullpage
Allowed values: popup fullpage
error
Any of:
string
realmId
Any of:
string
shop
Any of:
string

Shopify shop domain

hmac
Any of:
string

Shopify HMAC-SHA256 over callback params

timestamp
Any of:
string

Shopify-supplied Unix timestamp (included in HMAC)

Successful Response

Media typetext/html
string

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}