Get Flex Documentation

GET/integrations/flex

Returns the organization's Flex event sync configuration and its field mappings. On a mapping, ValueMappings translate each Flex option to a BackOps Select option id (or to an event type id on an EventType mapping), PushToFlex marks a mapping that writes BackOps changes back to Flex, and on a pushed status mapping StatusPushActions name the Flex workflow action that reaches each status from each starting state. Requires OrganizationAdmin. Use Integrations_GetContactConfig for the contact sync.

Response

Field	Type	Description
instanceName	string\| null
credentialSet	boolean
isEnabled	boolean
elementDefinitionId	string\| null
elementDefinitionName	string\| null
syncIntervalMinutes	integer\| null
syncStartDate	date-time\| null
lastSyncedAt	date-time\| null
eventTemplateId	uuid\| null
eventTypeId	uuid\| null
initialUserId	uuid\| null
initialCollaboratorName	string\| null
sourceOfTruth	string\| null
mappings	GetFlexConfigResponseMappingInfo[]\| null

GetFlexConfigResponseMappingInfo

Field	Type	Description
flexFieldId	string\| null
flexFieldCaption	string\| null
flexValueType	string\| null
staticValue	string\| null
backOpsTargetType	string\| null
backOpsTargetId	string\| null
backOpsTargetCaption	string\| null
backOpsTargetValueType	string\| null
pushToFlex	boolean
valueMappings	GetFlexConfigResponseValueMappingInfo[]\| null
statusPushActions	GetFlexConfigResponseStatusPushActionInfo[]\| null

GetFlexConfigResponseValueMappingInfo

Field	Type	Description
flexValueId	string\| null
flexValueName	string\| null
backOpsOptionValue	string\| null

GetFlexConfigResponseStatusPushActionInfo

Field	Type	Description
flexTargetStatusId	string\| null
flexSourceStateId	string\| null
flexSourceStateName	string\| null
flexActionId	string\| null
flexActionName	string\| null