Skip to main content
The ExternalAuthConnected event fires whenever a user successfully authenticates and connects an external provider to your app within the HoopAI platform. It identifies the app, the location or agency context, and the user who performed the connection. Use this event to initialize third-party service integrations, store provider tokens, or trigger onboarding steps that depend on external auth being in place.

​
Payload

FieldTypeDescription
typestringAlways "EXTERNAL_AUTH_CONNECTED"
appIdstringID of the app the external auth was connected to
locationIdstringSub-account ID where the connection was made
companyIdstringAgency ID associated with the account
userIdstringID of the user who performed the external auth connection

​
Example payload

{
  "type": "EXTERNAL_AUTH_CONNECTED",
  "appId": "ve9EPM428h8vShlRW1KT",
  "locationId": "otg8dTQqGLh3Q6iQI55w",
  "companyId": "otg8dTQqGLh3Q6iQI55w",
  "userId": "otg8dTQqGLh3Q6iQI55w"
}
  • App Install — fires when your app is installed, which often precedes an external auth connection
  • OAuth 2.0 — authorization flow used during app and provider connections
Last modified on March 4, 2026