Connections

Connect OAuth provider

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.

post/orgs/connections/oauth/connect

Request

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

Request body

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

subdomainstring

The subdomain of the OAuth provider

environmentstring

The environment of the OAuth provider to connect (one of the provider environments, e.g. live or sandbox)

validation_urlstring uri required

The validation URL of the OAuth provider

connection_idstring

Existing connection to re-authenticate

Example request

{
  "type": "SLACK"
}

Response

The created or re-authenticated connection.

idstring 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

namestring nullable required

Optional name for the connection

external_namestring nullable required

Optional external name for the connection

external_idstring nullable required

Optional external identifier for the connection

status'ACTIVE' | 'INACTIVE' required
status_errorstring nullable required

Optional error message if the connection is in error state

created_atstring date-time nullable required

Timestamp of when the connection was created

updated_atstring date-time nullable required

Timestamp of when the connection was last updated

Example response

{
  "type": "SLACK",
  "name": "My Encompass Connection"
}

Changes

No recorded changes to this operation across all 1 revision of this API.