API ReferenceWhite Labels

Create White Label

Create a new white label integration.



This only works for sources that use OAuth2.0 authentication like Slack, Google Drive, GitHub, or HubSpot.

Sets up a custom OAuth integration using your own OAuth application credentials and branding. Once created, customers will see your company name during OAuth consent flows instead of Airweave. This requires you to have already configured your own OAuth application with the target service provider.

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
namestringRequired>=1 character<=64 characters

Human-readable name for the white label integration. This helps you identify the integration in the UI and should clearly describe its purpose (e.g., ‘Customer Portal Slack Integration’, ‘Enterprise Google Drive Access’).

source_short_namestringRequired

Technical identifier of the source type that this integration supports (e.g., ‘slack’, ‘google_drive’, ‘github’). This determines which service provider the OAuth integration connects to.

redirect_urlstringRequired
OAuth2 callback URL where users are redirected after completing authentication. This must be a valid HTTPS URL that your application can handle to receive the authorization code.
client_idstringRequired
OAuth2 client identifier provided by the service provider. This identifies your application during the OAuth consent flow and must match the client ID configured in the service provider's developer console.
client_secretstringRequired

OAuth2 client secret from your registered application. This is used to securely authenticate your application when exchanging authorization codes for access tokens. Keep this value secure and never expose it in client-side code.

allowed_originsstringRequired

Comma-separated list of allowed domains for OAuth flows and CORS. This prevents unauthorized websites from using your OAuth credentials and should include all domains where your application is hosted.

Response

Successful Response
namestring>=1 character<=64 characters

Human-readable name for the white label integration. This helps you identify the integration in the UI and should clearly describe its purpose (e.g., ‘Customer Portal Slack Integration’, ‘Enterprise Google Drive Access’).

source_short_namestring

Technical identifier of the source type that this integration supports (e.g., ‘slack’, ‘google_drive’, ‘github’). This determines which service provider the OAuth integration connects to.

redirect_urlstring
OAuth2 callback URL where users are redirected after completing authentication. This must be a valid HTTPS URL that your application can handle to receive the authorization code.
client_idstring
OAuth2 client identifier provided by the service provider. This identifies your application during the OAuth consent flow and must match the client ID configured in the service provider's developer console.
client_secretstring

OAuth2 client secret from your registered application. This is used to securely authenticate your application when exchanging authorization codes for access tokens. Keep this value secure and never expose it in client-side code.

allowed_originsstring

Comma-separated list of allowed domains for OAuth flows and CORS. This prevents unauthorized websites from using your OAuth credentials and should include all domains where your application is hosted.

idstringformat: "uuid"
Unique system identifier for the white label integration. This UUID is generated automatically and used for API operations and OAuth flow tracking.
organization_idstringformat: "uuid"

Identifier of the organization that owns this white label integration. White label integrations are isolated per organization for security and multi-tenancy.

created_atstringformat: "date-time"

Timestamp when the white label integration was created (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when the white label integration was last modified (ISO 8601 format).

created_by_emailstring or nullformat: "email"
Email address of the user who created this white label integration.
modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this white label integration.

Errors