Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

POST /api/auth/social/:provider/start

Authentication flow · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

  • Part of a browser authentication or connection flow. Keep the flow's state and cookies; provider values in examples must come from that flow.
  • provider is github or x and must be enabled. Start in the browser, retain the flow cookie, then navigate to the returned url. Linking requires a recent signed-in session. returnTo must be an allowed local path.
  • Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.

Request

ParameterLocationType and requirement
providerpathstring · required
Originheaderstring · required

An origin allowed by this deployment.

X-CSRF-Tokenheaderstring · required

Must match the CSRF cookie issued to this browser.

Body · application/json

intent optional · "signin" | "signup" | "link"
referralCode optional · string

pattern: ^[A-Za-z0-9_-]{1,32}$

returnTo optional · string

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

Save as request.json
{
  "intent": "signin",
  "returnTo": "/"
}
cURL (POSIX shell)
curl --include \
  --request POST \
  'https://api.weavers.app/api/auth/social/github/start' \
  --cookie cookies.txt --cookie-jar cookies.txt \
  --header 'Origin: https://weavers.app' \
  --header "X-CSRF-Token: ${CSRF_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

200 · Successful response.

application/json

200 example · synthetic data
{
  "url": "example"
}
View response model
url required · string

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

409 · Revision, state or idempotency conflict.

application/json

409 example · synthetic data
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

503 · Service or dependency unavailable.

application/json

503 example · synthetic data
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.

default · Operation-specific error. Inspect error/code before deciding whether to retry.

application/json

default example · synthetic data
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.