Start the authorization of a Connection

POST /v1/connections/{connection_id}/authorize

Answers the vendor's authorization URL for the Member's browser (1.60.0; integrations.md section 7): PKCE (S256), a single-use state valid 10 minutes (a target) bound to the Organization, the Member and the Connection, and the scopes of enabled_tools, nothing more. Session only: every API key is refused with forbidden, and a Member who is neither an owner nor an admin with the detail owner_or_admin_required. A Connection whose strategy is not OAuth is validation_failed with connection_not_authorizable. The edge role's callback completes the exchange; the Connection becomes active and writes connection.authorized.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/connections/con_.../authorize" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch(`${process.env.VOCAL_API}/v1/connections/con_.../authorize`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/connections/con_.../authorize",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is ConnectionAuthorization.