Create an integration

Settings module

POST/integrationsintegrations.create

An integration connection (Section 17). Credentials are stored in Supabase Vault through the credential action and never returned. Creates an integration. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.integrations.manage.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: IntegrationCreate

integrations.create: IntegrationCreate
Field	Type	Required	Description
provider_code	string	Yes	Provider.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
display_name	string	Yes	Name the org gives the connection.Constraints: length 1 to 120
external_account_id	string \| null	No	Provider tenant, company or workspace id.Constraints: length 1 to 255

{
  "provider_code": "xero",
  "display_name": "Northwind Xero",
  "external_account_id": "tenant-nwl"
}

Response 201: Integration

integrations.create: Integration
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the integration.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
provider_code	string	Yes	Provider.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
last_synced_at	string (date-time) \| null	Yes	Last successful sync.
display_name	string	Yes	Name the org gives the connection.Constraints: length 1 to 120
external_account_id	string \| null	Yes	Provider tenant, company or workspace id.Constraints: length 1 to 255
connection_state	"Pending" \| "Connected" \| "Error" \| "Paused" \| "Disconnected"	Yes	Connection state; changes through the transitions action.
credential_kind	"OAuth Token" \| "API Key" \| "Service Account" \| null	Yes	Kind of the stored Vault credential.
credential_expires_at	string (date-time) \| null	Yes	When the stored credential expires.
last_error_code	string \| null	Yes	Rule code of the last connection error.Constraints: pattern ^[a-z][a-z0-9_]*$
last_error_message	string \| null	Yes	Provider message of the last connection error.Constraints: length 1 to 1000

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "provider_code": "xero",
  "last_synced_at": "2026-10-08T14:30:00Z",
  "display_name": "Northwind Xero",
  "external_account_id": "tenant-nwl",
  "connection_state": "Connected",
  "credential_kind": "OAuth Token",
  "credential_expires_at": "2026-10-08T14:30:00Z",
  "last_error_code": "credential_refused",
  "last_error_message": "Xero refused the token."
}

Code samples

curl -X POST "$XOS_BASE_URL/integrations" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"provider_code":"xero","display_name":"Northwind Xero","external_account_id":"tenant-nwl"}'

const { data } = await xos.integrations.create({
    "provider_code": "xero",
    "display_name": "Northwind Xero",
    "external_account_id": "tenant-nwl"
  });

response = xos.integrations.create({"provider_code": "xero", "display_name": "Northwind Xero", "external_account_id": "tenant-nwl"})

xos integrations create --data '{"provider_code":"xero","display_name":"Northwind Xero","external_account_id":"tenant-nwl"}'