Skip to main content
POST
/
orgs
/
{org_id}
/
connections
/
oauth
/
validate
Authenticate OAuth Provider
curl --request POST \
  --url https://api.example.com/orgs/{org_id}/connections/oauth/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "SLACK",
  "validation_url": "<string>",
  "subdomain": "<string>"
}
'
{
  "config": {
    "type": "OAUTH",
    "access_token": "<string>",
    "refresh_token": "<string>",
    "expires_in": 1,
    "next_refresh_at": 123,
    "scope": "<string>",
    "api_url": "<string>",
    "subdomain": "<string>"
  },
  "user": {
    "external_id": "<string>",
    "external_name": "<string>"
  }
}

Path Parameters

org_id
string
required

Body

OAuth provider authentication request

type
enum<string>
required

Connection type

Available options:
SCHEDULER,
WORKFLOWS,
TOOLS,
FILES,
PHONE,
GMAIL,
GOOGLE_SHEETS,
GOOGLE_CALENDAR,
AIRTABLE,
NOTION,
LINEAR,
HUBSPOT,
GOHIGHLEVEL,
CAL,
CALENDLY,
RESEND,
OAUTH,
SLACK,
TELEGRAM,
TRELLO,
FACEBOOK,
WHATSAPP,
INSTAGRAM,
MESSENGER,
JAPIFON,
TWILIO,
ZOHO,
SALESFORCE,
STRIPE,
SHOPIFY,
ZENDESK,
MCP
Example:

"SLACK"

validation_url
string<uri>
required

The validation URL of the OAuth provider

Maximum string length: 10000
subdomain
string

The subdomain of the OAuth provider

Response

200 - application/json

The access token to authenticate with the OAuth provider.

OAuth provider validated connection

config
object
required

Configuration of an OAuth connection

user
object
required

OAuth provider user