Create Account Integration

Beta

POST/v1/settings/integrations

Idempotent with Idempotency-Key header. Learn more

Creates an account integration, or updates the name and credentials of an existing one with the same integration code.

Credentials are validated for the provider, encrypted at rest, and never returned in API responses. An account can have at most one integration per integration code.

namestring

Display name of the integration.

providerstringenumValues:stripeshippohubspot

Integration provider code.

stripe: Stripe payment processing.
shippo: Shippo shipping and label generation.
hubspot: HubSpot CRM.

credentialsstring

JSON string containing the provider's credentials.

Required keys depend on the provider:

stripe: private_key (sk_...), publishable_key (pk_...), and webhook_secret (whsec_...).
shippo: api_key (shippo_live_... or shippo_test_...).
hubspot: access_token (pat-...).

Sandbox accounts must use test keys and production accounts must use live keys; credentials that do not match are rejected.

idstring

Account integration ID.

objectstringenumValues:account_integration

Resource type identifier.

namestring

Display name of the integration.

providerstringenumValues:stripeshippohubspot

Integration provider code.

stripe: Stripe payment processing.
shippo: Shippo shipping and label generation.
hubspot: HubSpot CRM.

statusstringenumValues:activeinactive

Lifecycle status of the integration.

Integrations are created active. Setting an integration to inactive keeps its stored credentials but stops it from being used (for example, the Stripe publishable key cannot be retrieved while the Stripe integration is inactive).

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Account Integration

Create Account Integration

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountIntegration = await client.settings.integrations.create({
  credentials:
    '{"private_key":"sk_test_...","publishable_key":"pk_test_...","webhook_secret":"whsec_..."}',
  name: 'My Stripe Integration',
  provider: 'stripe',
});

console.log(accountIntegration.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountIntegration = await client.settings.integrations.create({
  credentials:
    '{"private_key":"sk_test_...","publishable_key":"pk_test_...","webhook_secret":"whsec_..."}',
  name: 'My Stripe Integration',
  provider: 'stripe',
});

console.log(accountIntegration.id);

201 example

{
  "id": "acig_0177772eae113431f64d473124",
  "object": "account_integration",
  "name": "My Stripe Integration",
  "provider": "stripe",
  "status": "active",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acig_0177772eae113431f64d473124",
  "object": "account_integration",
  "name": "My Stripe Integration",
  "provider": "stripe",
  "status": "active",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Account Integration

Request Body

Returns

Responses