---
title: "Connect OAuth provider"
method: POST
path: "/orgs/connections/oauth/connect"
tags: ["Connections"]
---

# Connect OAuth provider

`POST /orgs/connections/oauth/connect`

## Request

- Base URL: `https://api.useinvent.com`
- URL: `https://api.useinvent.com/orgs/connections/oauth/connect`
- Auth: HTTP bearer

Step 2, recommended option. Send the full redirect URL from step 1 as `validation_url`. Creates or re-authenticates the connection in one call, and the tokens stay on the server.

## Request body

- ConnectConnectionOAuthSchema: OAuth provider connect request
  - `type` 'SCHEDULER' | 'WORKFLOWS' | 'TOOLS' | 'FILES' | 'EMAILS' | 'HTTP_CREDENTIALS' | 'TABLES' | 'PAGES' | 'KNOWLEDGE' | 'SKILLS' | 'CONTACTS' | 'SEGMENTS' | 'ASSISTANTS' | 'AGENTS' | 'CHATS' | 'INBOX' | 'MEMBERS' | 'SUB_ORGS' | 'BILLING' | 'BROADCASTS' | 'ANALYTICS' | 'AUDIT' | 'PHONE' | 'GMAIL' | 'GOOGLE_SHEETS' | 'GOOGLE_CALENDAR' | 'GOOGLE_DRIVE' | 'GOOGLE_MEET' | 'ONEDRIVE' | 'SHAREPOINT' | 'OUTLOOK_CALENDAR' | 'OUTLOOK' | 'AIRTABLE' | 'NOTION' | 'LINEAR' | 'HUBSPOT' | 'GOHIGHLEVEL' | 'CAL' | 'CALENDLY' | 'RESEND' | 'OAUTH' | 'SLACK' | 'TEAMS' | 'TELEGRAM' | 'TRELLO' | 'FACEBOOK' | 'WHATSAPP' | 'INSTAGRAM' | 'MESSENGER' | 'TIKTOK' | 'JAPIFON' | 'SMPP' | 'TWILIO' | 'TELNYX' | 'ZOHO' | 'ZOHO_BOOKINGS' | 'ZOHO_INVENTORY' | 'ZOHO_CALENDAR' | 'SALESFORCE' | 'STRIPE' | 'SHOPIFY' | 'ZENDESK' | 'MCP' | 'OPENAPI' | 'ODOO' | 'WOOCOMMERCE', required: Connection type
  - `subdomain` string: The subdomain of the OAuth provider
  - `environment` string: The environment of the OAuth provider to connect (one of the provider environments, e.g. live or sandbox)
  - `validation_url` string, uri, required: The validation URL of the OAuth provider
  - `connection_id` string: Existing connection to re-authenticate

## Response `200`

The created or re-authenticated connection.

- ConnectionSchema: Detailed information about a connection
  - `id` string, required: Unique identifier for the connection
  - `type` 'SCHEDULER' | 'WORKFLOWS' | 'TOOLS' | 'FILES' | 'EMAILS' | 'HTTP_CREDENTIALS' | 'TABLES' | 'PAGES' | 'KNOWLEDGE' | 'SKILLS' | 'CONTACTS' | 'SEGMENTS' | 'ASSISTANTS' | 'AGENTS' | 'CHATS' | 'INBOX' | 'MEMBERS' | 'SUB_ORGS' | 'BILLING' | 'BROADCASTS' | 'ANALYTICS' | 'AUDIT' | 'PHONE' | 'GMAIL' | 'GOOGLE_SHEETS' | 'GOOGLE_CALENDAR' | 'GOOGLE_DRIVE' | 'GOOGLE_MEET' | 'ONEDRIVE' | 'SHAREPOINT' | 'OUTLOOK_CALENDAR' | 'OUTLOOK' | 'AIRTABLE' | 'NOTION' | 'LINEAR' | 'HUBSPOT' | 'GOHIGHLEVEL' | 'CAL' | 'CALENDLY' | 'RESEND' | 'OAUTH' | 'SLACK' | 'TEAMS' | 'TELEGRAM' | 'TRELLO' | 'FACEBOOK' | 'WHATSAPP' | 'INSTAGRAM' | 'MESSENGER' | 'TIKTOK' | 'JAPIFON' | 'SMPP' | 'TWILIO' | 'TELNYX' | 'ZOHO' | 'ZOHO_BOOKINGS' | 'ZOHO_INVENTORY' | 'ZOHO_CALENDAR' | 'SALESFORCE' | 'STRIPE' | 'SHOPIFY' | 'ZENDESK' | 'MCP' | 'OPENAPI' | 'ODOO' | 'WOOCOMMERCE', required: Connection type
  - `name` string, nullable, required: Optional name for the connection
  - `external_name` string, nullable, required: Optional external name for the connection
  - `external_id` string, nullable, required: Optional external identifier for the connection
  - `status` 'ACTIVE' | 'INACTIVE', required
  - `status_error` string, nullable, required: Optional error message if the connection is in error state
  - `config` union, required: Configuration of a connection
    - object: Configuration of an Phone connection
      - `type` 'PHONE', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `phone` string, required: The phone number to send the verification code to
      - `code` number: The validation code
    - object: Configuration of an Emails connection
      - `type` 'EMAILS', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
    - object: Configuration of an OAuth connection
      - `type` 'OAUTH', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `access_token` string, required: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an OAuth connection
      - `type` 'OAUTH', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an MCP connection
      - `type` 'MCP', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `url` string, required: The URL of the MCP server
      - `auth_type` 'none' | 'bearer' | 'basic' | 'custom_header' | 'oauth', required: How to authenticate against the server
      - `token` string: The bearer token for authentication
      - `username` string: Username for Basic authentication
      - `password` string: Password for Basic authentication
      - `header_name` string: The name of the custom header
      - `header_value` string: The value for the custom header
      - `oauth_grant` 'authorization_code' | 'client_credentials': Sign in opens the service in a window and keeps the session fresh. Client credentials use a server key pair.
      - `authorization_url` string: Where the sign-in happens. Leave empty to discover it from the server.
      - `token_url` string: Endpoint that issues access tokens. Leave empty to discover it when signing in.
      - `client_id` string: Leave empty when the service registers apps on its own.
      - `client_secret` string
      - `scope` string: Space-separated list of scopes to request.
      - `access_token` string: The cached access token
      - `refresh_token` string: The cached refresh token (if returned by the token endpoint)
      - `next_refresh_at` number: Unix seconds when the cached token must be refreshed
      - `client_auth` string: How the client secret reaches the token endpoint, as chosen at sign-in
      - `resource` string: The resource indicator (RFC 8707) sent with token requests
      - `headers` string: Additional headers as JSON key-value pairs
    - object: Configuration of an OpenAPI connection
      - `type` 'OPENAPI', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `spec_url` string, required: URL of the OpenAPI 3.x or Swagger 2.0 spec (JSON or YAML)
      - `server_url` string: Overrides the spec's own server URL
      - `auth_type` 'none' | 'bearer' | 'basic' | 'custom_header' | 'oauth', required: How to authenticate against the server
      - `token` string: The bearer token for authentication
      - `username` string: Username for Basic authentication
      - `password` string: Password for Basic authentication
      - `header_name` string: The name of the custom header
      - `header_value` string: The value for the custom header
      - `oauth_grant` 'authorization_code' | 'client_credentials': Sign in opens the service in a window and keeps the session fresh. Client credentials use a server key pair.
      - `authorization_url` string: Where the sign-in happens. Leave empty to discover it from the server.
      - `token_url` string: Endpoint that issues access tokens. Leave empty to discover it when signing in.
      - `client_id` string: Leave empty when the service registers apps on its own.
      - `client_secret` string
      - `scope` string: Space-separated list of scopes to request.
      - `access_token` string: The cached access token
      - `refresh_token` string: The cached refresh token (if returned by the token endpoint)
      - `next_refresh_at` number: Unix seconds when the cached token must be refreshed
      - `client_auth` string: How the client secret reaches the token endpoint, as chosen at sign-in
      - `resource` string: The resource indicator (RFC 8707) sent with token requests
      - `headers` string: Extra headers as JSON key-value pairs, sent with every call
    - object: Configuration of an HTTP Credentials connection
      - `type` 'HTTP_CREDENTIALS', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `auth_type` 'bearer' | 'basic' | 'custom_header' | 'oauth', required: The type of HTTP authentication to use
      - `token` string: The bearer token for authentication
      - `username` string: Username for Basic authentication
      - `password` string: Password for Basic authentication
      - `header_name` string: The name of the custom header
      - `header_value` string: The value for the custom header
      - `oauth_grant` 'authorization_code' | 'client_credentials': Sign in opens the service in a window and keeps the session fresh. Client credentials use a server key pair.
      - `authorization_url` string: Where the sign-in happens. Leave empty to discover it from the server.
      - `token_url` string: Endpoint that issues access tokens. Leave empty to discover it when signing in.
      - `client_id` string: Leave empty when the service registers apps on its own.
      - `client_secret` string
      - `scope` string: Space-separated list of scopes to request.
      - `access_token` string: The cached access token
      - `refresh_token` string: The cached refresh token (if returned by the token endpoint)
      - `next_refresh_at` number: Unix seconds when the cached token must be refreshed
      - `client_auth` string: How the client secret reaches the token endpoint, as chosen at sign-in
      - `resource` string: The resource indicator (RFC 8707) sent with token requests
    - object: Configuration of an Google Sheets connection
      - `type` 'GOOGLE_SHEETS', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Google Calendar connection
      - `type` 'GOOGLE_CALENDAR', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Google Meet connection
      - `type` 'GOOGLE_MEET', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Microsoft Outlook Calendar connection
      - `type` 'OUTLOOK_CALENDAR', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Google Drive connection
      - `type` 'GOOGLE_DRIVE', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Microsoft OneDrive connection
      - `type` 'ONEDRIVE', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Microsoft SharePoint connection
      - `type` 'SHAREPOINT', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Airtable connection
      - `type` 'AIRTABLE', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Notion connection
      - `type` 'NOTION', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Linear connection
      - `type` 'LINEAR', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Trello connection
      - `type` 'TRELLO', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an HubSpot connection
      - `type` 'HUBSPOT', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Salesforce connection
      - `type` 'SALESFORCE', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Zoho CRM connection
      - `type` 'ZOHO', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Zoho Bookings connection
      - `type` 'ZOHO_BOOKINGS', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Zoho Inventory connection
      - `type` 'ZOHO_INVENTORY', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Zoho Calendar connection
      - `type` 'ZOHO_CALENDAR', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an GoHighLevel connection
      - `type` 'GOHIGHLEVEL', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Cal.com connection
      - `type` 'CAL', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Calendly connection
      - `type` 'CALENDLY', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Slack connection
      - `type` 'SLACK', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Microsoft Teams connection
      - `type` 'TEAMS', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Telegram connection
      - `type` 'TELEGRAM', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `api_key` string, required: The bot token from @BotFather
    - object: Configuration of an Instagram connection
      - `type` 'INSTAGRAM', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Messenger connection
      - `type` 'MESSENGER', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an TikTok connection
      - `type` 'TIKTOK', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an WhatsApp connection
      - `type` 'WHATSAPP', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Gmail connection
      - `type` 'GMAIL', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Microsoft Outlook connection
      - `type` 'OUTLOOK', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Japifon connection
      - `type` 'JAPIFON', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `api_key` string, required: Your Japifon API Key
    - object: Configuration of an SMPP connection
      - `type` 'SMPP', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `host` string, required: SMSC hostname or IP address
      - `port` number, required: SMPP port (2775 plain, commonly 2776 for TLS)
      - `tls` boolean: Connect over TLS
      - `version` '3.4': Protocol version negotiated on bind
      - `system_id` string, required: SMPP system_id issued by the carrier
      - `password` string, required: SMPP password issued by the carrier
      - `system_type` string: SMPP system_type, when the carrier requires one
      - `sender` string: Default source address for outbound messages (the carrier may overwrite it on long-code routes)
      - `encoding` 'unicode' | 'latin1' | 'transliterate', required: How accents travel to the carrier. Unicode always arrives intact. Latin-1 fits twice as many characters per segment, but a carrier that ignores data_coding 3 accepts the message and then silently drops the accents — only pick it once the carrier confirms it supports it. Transliterate rewrites the accents GSM lacks (código to codigo) to keep every message on the cheapest encoding.
      - `traffic_type` 'transactional' | 'marketing' | 'both', required: Traffic profile of this bind. Carriers audit this: marketing must never be sent through a transactional (OTP) bind. Use Both only when the carrier issued a single system_id for all traffic.
    - object: Configuration of an Twilio connection
      - `type` 'TWILIO', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `account_sid` string, required: Your Twilio Account SID from the console
      - `auth_token` string, required: Your Twilio Auth Token (keep this secret)
    - object: Configuration of an Telnyx connection
      - `type` 'TELNYX', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `api_key` string, required: Your Telnyx API Key (API v2)
    - object: Configuration of an Resend connection
      - `type` 'RESEND', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `api_key` string, required: The API key for Resend
    - object: Configuration of an Stripe connection
      - `type` 'STRIPE', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Shopify connection
      - `type` 'SHOPIFY', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Zendesk connection
      - `type` 'ZENDESK', required: The type of the connection
      - `auth_method` 'OAUTH', required: The authentication method to use
      - `access_token` string: The access token for OAuth authentication
      - `refresh_token` string: The refresh token for OAuth authentication
      - `expires_in` number: The expiration time of the access token
      - `next_refresh_at` number: The timestamp when the access token will be refreshed
      - `scope` string: The scope of the access token
      - `api_url` string
      - `profile_url` string
      - `subdomain` string
      - `environment` string
    - object: Configuration of an Odoo CRM connection
      - `type` 'ODOO', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `url` string, required: Your Odoo instance URL
      - `database` string, required: The name of your Odoo database
      - `username` string, required: Your Odoo username or email
      - `api_key` string, required: API key from Odoo (Settings > Users > API Keys)
    - object: Configuration of an WooCommerce connection
      - `type` 'WOOCOMMERCE', required: The type of the connection
      - `auth_method` 'MANUAL', required: The authentication method to use
      - `store_url` string, required: Your WooCommerce store URL (must use HTTPS)
      - `consumer_key` string, required: Generate from WooCommerce > Settings > Advanced > REST API (Read/Write)
      - `consumer_secret` string, required: The Consumer Secret paired with your Consumer Key
  - `email_identity` EmailIdentitySchema: An email identity
    - `id` string, required: Unique identifier for the email identity
    - `email` string, required: Email address of the identity
    - `name` string, nullable, required: Display name for the identity
    - `status` 'PENDING' | 'VERIFIED' | 'FAILED', required: Verification status of an email identity
    - `domain` EmailDomainSchema, required: Linked email domain
      - `id` string, required: Unique identifier for the email domain
      - `domain` string, required: The domain name
      - `dkim_status` 'PENDING' | 'VERIFIED' | 'FAILED', required: DKIM verification status of an email domain
      - `dkim_tokens` EmailDomainDkimTokenSchema[], nullable, required: DKIM CNAME records to add to DNS
        - `name` string, required: CNAME record name
        - `value` string, required: CNAME record value
      - `verified_at` string, date-time, nullable, required: Timestamp when the domain was verified
      - `created_at` string, date-time, nullable, required: Timestamp when the domain was created
      - `updated_at` string, date-time, nullable, required: Timestamp when the domain was last updated
    - `is_default` boolean, required: Whether this is the default identity for the org
    - `click_tracking` boolean, required: Whether click tracking is enabled for this identity
    - `open_tracking` boolean, required: Whether open tracking is enabled for this identity
    - `verified_at` string, date-time, nullable, required: Timestamp when the identity was verified
    - `created_at` string, date-time, nullable, required: Timestamp when the identity was created
    - `updated_at` string, date-time, nullable, required: Timestamp when the identity was last updated
  - `created_at` string, date-time, nullable, required: Timestamp of when the connection was created
  - `updated_at` string, date-time, nullable, required: Timestamp of when the connection was last updated

---

[API](https://skmtc.dev/useinvent/apis/invent-api.md) · [All operations](https://skmtc.dev/useinvent/apis/invent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useinvent/apis/invent-api/revisions/98824f3fde82?raw)