API examples

Use examples that map to the live route tree and current auth models.

These examples are intentionally tied to routes that already exist in the platform. They are not meant to imply that every route is public or unauthenticated; the auth model depends on the route family.

Example: fetch the public OpenAPI spec

curl https://app.vexylcloud.com/api/openapi.json

The OpenAPI document is the canonical public schema source for the platform API.

Example: initiate VexylCloud SSO by domain

curl -X POST https://app.vexylcloud.com/api/auth/sso 
  -H "Content-Type: application/json" 
  -d '{"domain":"example.com"}'

This starts the VexylCloud platform SSO flow for a domain with an enabled provider.

Example: create a tenant API key

curl -X POST https://app.vexylcloud.com/api/admin/api-keys 
  -H "Content-Type: application/json" 
  -H "Cookie: sb-...=..." 
  -d '{"name":"Automation Key","scopes":["*"],"expires_days":30}'

This route is tenant-scoped and requires authenticated admin context. The plaintext key is only returned once on creation.

Example: create a tenant webhook endpoint

curl -X POST https://app.vexylcloud.com/api/admin/webhooks 
  -H "Content-Type: application/json" 
  -H "Cookie: sb-...=..." 
  -d '{"name":"PSA Events","url":"https://example.com/webhooks/vexyl","events":["ticket.created","ticket.updated"]}'

This stores a tenant-scoped webhook endpoint with its event subscriptions and generated secret.

Want route examples mapped to your integration use case?

Use the API, authentication, and webhook pages together, or book a walkthrough if you want the live route families mapped to your stack.

Open API Open Webhooks