Britixo CRMBritixo CRM Enterprise Help Centre
Help centreProplix Secure API GatewayUse the Service Journeys adapter
Automatic enabled-module adapters

Use the Service Journeys adapter

Journey applications and client-visible related records.

Audience: CRM administrators, integration developers, external portal backend teams and security reviewersPermission: Valid short-lived client sessionModule v1.0.0
Exact navigationExternal backend → GET /portal_api/me or supported workspace endpoint
Before you begin
  • Confirm the module is active and use the exact navigation shown above.
  • Use an account with the stated module and core CRM permissions.
  • Use known test records when changing statuses, visibility, saved filters or global navigation.

What this guide covers

Journey applications and client-visible related records. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.

Exact step-by-step process

  1. Open External backend → GET /portal_api/me or supported workspace endpoint.
  2. Locate the record, endpoint, field or action used to use the service journeys adapter.
  3. Complete the displayed values exactly as described in this guide.
  4. Select the available save, submit, send, upload, create, update or confirm action.
  5. Return to the related register, portal, activity log or API response and verify the expected result.

Fields, choices and supported possibilities

AdapterService Journeys
DataJourney applications and client-visible related records.

Code-backed validations and workflow rules

  • The underlying module must be active and its expected tables/fields available.
  • Only records owned by the authenticated client/contact and allowed for portal visibility are returned.

Expected result and verification

  • The use the service journeys adapter workflow completes without a validation, permission, ownership or availability error.
  • The related record, portal view, activity entry, notification log or API response shows the expected state.
  • Client-visible, public and API data remains limited to the code-backed ownership and visibility rules.

Security, privacy and operational checks

  • Use controlled test records and non-production credentials before wider rollout.
  • Grant least privilege and protect secure links, personal data, uploaded files, signatures, API tokens, allowed origins and server IPs.
Understand missing adapter dataUse the Licence Applications adapterAutomatic enabled-module adaptersBrowse all Proplix Secure API Gateway guidesEnterprise integrationsClient portal overviewApply API request throttlingUnderstand one-way API-token storageManage API-token lifecycle metadataData, privacy and security