Skip to main content
Version: 2

Plinqx Permission Sets (External User Guide)

info

This guide describes what each Plinqx permission set provides and when to use it. It is based on the metadata in force-app/main/default/permissionsets.

Plinqx Administrator​

Purpose: Full administrative access to Plinqx features and data.

Provides

  • Full access to the Plinqx app and tabs (Design Studio, Feature Management, Log, Publisher, Transaction).
  • Broad Apex class access (including configuration, metadata, transformation, and integration services).
  • Full CRUD with Modify All on Plinqx objects (Log__c, Transaction__c, Webhook_API_Key__c).
  • Access to Plinqx Visualforce pages (GenerateSessionIdForLWC, reprocessTransaction, transformationDesigner).
  • User-level setup permissions: Customize Application, Manage Custom Permissions, Modify Metadata, View Roles, View Setup.

Use when

  • You need to administer or configure Plinqx, manage metadata, or troubleshoot across all Plinqx data.
  • You are responsible for system-level setup or deployment tasks.

Plinqx Integration User​

Purpose: Integration account access without the API Access custom permission.

Provides

  • Broad Apex class access required for runtime processing, transformations, callouts, and integrations.
  • Read/write access to key operational data (create/read for Log__c, full CRUD for Transaction__c).
  • Access to Plinqx custom settings and metadata used by integrations (Configuration__c, Event__mdt, Mapping_and_Function__mdt).

Use when

  • You are configuring a service account or integration user that should run Plinqx processes but should not have the API Access custom permission.

Plinqx API Access​

Purpose: Grants the Plinqx API Access custom permission.

Provides

  • The API Access custom permission only (no additional object or class access by itself).

Use when

  • You need to enable API-level access in addition to another permission set (typically combined with Plinqx Integration User or Plinqx Administrator).

Plinqx Manage Webhooks​

Purpose: Full management of webhook API keys.

Provides

  • Apex class access for webhook management.
  • Full CRUD access to Webhook_API_Key__c plus editable access to the key fields (Active, Allowed IPs, Endpoint Pattern, Expiration Date, Last Used, Notes, Usage Count).

Use when

  • A user needs to create, update, rotate, or deactivate webhook API keys.

Plinqx Read Webhooks​

Purpose: Read-only access to webhook API keys.

Provides

  • Apex class access for webhook viewing.
  • Read-only access to Webhook_API_Key__c and its key fields.

Use when

  • A user needs to view webhook configuration or audit usage but should not edit keys.
  • Plinqx Administrator: Admins and system owners.
  • Plinqx Integration User + Plinqx API Access: API-driven integrations that should be allowed to call Plinqx APIs.
  • Plinqx Integration User (without API Access): Background integrations that should run internal processes but not expose API endpoints.
  • Plinqx Manage Webhooks: Security or integration admins managing webhook keys.
  • Plinqx Read Webhooks: Auditors or support users who need visibility only.