Connect OAuth Provider
Authenticate with an OAuth provider and create or re-authenticate the connection in one call. Credentials stay on the server.
Authorizations
Bearer token authentication using your API key
Path Parameters
Body
OAuth provider connect request
Connection type
SCHEDULER, WORKFLOWS, TOOLS, FILES, EMAILS, HTTP_CREDENTIALS, TABLES, PAGES, KNOWLEDGE, SKILLS, CONTACTS, SEGMENTS, ASSISTANTS, INBOX, MEMBERS, BROADCASTS, ANALYTICS, AUDIT, PHONE, GMAIL, GOOGLE_SHEETS, GOOGLE_CALENDAR, GOOGLE_DRIVE, OUTLOOK_CALENDAR, AIRTABLE, NOTION, LINEAR, HUBSPOT, GOHIGHLEVEL, CAL, CALENDLY, RESEND, OAUTH, SLACK, TELEGRAM, TRELLO, FACEBOOK, WHATSAPP, INSTAGRAM, MESSENGER, TIKTOK, JAPIFON, SMPP, TWILIO, TELNYX, ZOHO, ZOHO_BOOKINGS, ZOHO_INVENTORY, ZOHO_CALENDAR, SALESFORCE, STRIPE, SHOPIFY, ZENDESK, MCP, ODOO, WOOCOMMERCE "SLACK"
The validation URL of the OAuth provider
10000The subdomain of the OAuth provider
^[a-z0-9-]+$Existing connection to re-authenticate
128Response
The created or re-authenticated connection.
Detailed information about a connection
Unique identifier for the connection
Connection type
SCHEDULER, WORKFLOWS, TOOLS, FILES, EMAILS, HTTP_CREDENTIALS, TABLES, PAGES, KNOWLEDGE, SKILLS, CONTACTS, SEGMENTS, ASSISTANTS, INBOX, MEMBERS, BROADCASTS, ANALYTICS, AUDIT, PHONE, GMAIL, GOOGLE_SHEETS, GOOGLE_CALENDAR, GOOGLE_DRIVE, OUTLOOK_CALENDAR, AIRTABLE, NOTION, LINEAR, HUBSPOT, GOHIGHLEVEL, CAL, CALENDLY, RESEND, OAUTH, SLACK, TELEGRAM, TRELLO, FACEBOOK, WHATSAPP, INSTAGRAM, MESSENGER, TIKTOK, JAPIFON, SMPP, TWILIO, TELNYX, ZOHO, ZOHO_BOOKINGS, ZOHO_INVENTORY, ZOHO_CALENDAR, SALESFORCE, STRIPE, SHOPIFY, ZENDESK, MCP, ODOO, WOOCOMMERCE "SLACK"
Optional name for the connection
"My Encompass Connection"
Optional external name for the connection
Optional external identifier for the connection
ACTIVE, INACTIVE Optional error message if the connection is in error state
Configuration of a connection
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
Timestamp of when the connection was created
Timestamp of when the connection was last updated
An email identity