AbstractProtected AbstractcrmThe CRM provider this action is designed for (e.g., 'HubSpot', 'Salesforce', etc.)
Protected AbstractintegrationThe integration name to look up in the Integration entity
Static ReadonlyAuthorizesTrue when the action authorizes its caller itself, so a public entry point such as the
RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller
must hold, or reads and writes only with the caller's own permissions. Leave it false for an
action that acts with more authority than its caller, or that reaches data or sends messages
the caller chooses but could not otherwise reach.
The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.
Whether this action can bound what it returns to an audience (RunActionParams.Audience): everyone
besides the caller who will see its output, such as the other participants of a shared conversation.
false by default, and the engine enforces it: when a run's audience adds a reader beyond the caller,
ActionEngineServer.RunAction refuses the action with result code AUDIENCE_UNSUPPORTED, without running
it. Override to return true only when the action honours the audience in full — every record, snippet
and count it returns is something every reader may see (pass the audience to the search engine, check each
reader's entitlement to anything it scopes by, and leave out aggregates computed before that filtering).
ProtectedbuildHelper to build consistent error messages for CRM operations
OptionalsystemError: anyProtectedformatStandard date format for CRM systems (ISO 8601)
ProtectedformatFormat phone numbers to E.164 format if possible
ProtectedgetGets the base URL for API calls
ProtectedgetGets API credentials - first tries environment variables, then falls back to database
ProtectedgetCommon CRM parameters that many actions will need
ProtectedgetGets the company integration record for the specified company and CRM
ProtectedgetGets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_HUBSPOT_12345_API_KEY
ProtectedgetHelper to get parameter value with type safety
Protected AbstractInternalInternal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
The action execution parameters including typed context
Promise resolving to the action result
ProtectedisValidate email format
ProtectedmapCommon activity types mapping
ProtectedmapMap deal/opportunity stages to common statuses
ProtectedparseParse date from CRM format
Executes the action with the provided parameters.
The action execution parameters including context
Promise resolving to the action result
Base class for all CRM-related actions. Provides common functionality and patterns for interacting with Customer Relationship Management systems.