> ## Documentation Index
> Fetch the complete documentation index at: https://memberpulseptyltd.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Integration Settings

> Integration configuration and credentials entity

Integration configuration and credentials entity

Stores configuration and credentials for external integrations.

## Fields

### Field Registry (from `workspace/sources/entity-registry.csv`)

#### CRM Settings

| Field             | Input Type | Required     | Notes                                                                                                                                  |
| ----------------- | ---------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| Platform          | Selector   | -            | Select from a system we integrate with                                                                                                 |
| API Key           | Text       | -            | If not empty the below fields show up                                                                                                  |
| Member Object     | Selector   | Required     | Pulls through a list of all available objects from the CRM platform                                                                    |
| All Member Fields | -          | Required     | Displays a list of all the fields in Member Pulse and maps this against all the fields in the CRM in two dropdowns so you can map them |
| Event Tag         | -          | Required     | Allows the admin to select a field in their CRM to map all event attendance/registration to                                            |
| Course Tag        | -          | -            | Allows the admin to select a field in their CRM to map all courses they've completed                                                   |
| Order Object      | Selector   | Not Required | Allows you to map any order/transactions against a particular object in their CRM                                                      |
| All Order Fields  | -          | Required     | Displays a list of all the fields in Member Pulse and maps this against all the fields in the CRM in two dropdowns so you can map them |

#### Accounting Settings

| Field    | Input Type | Required | Notes                                  |
| -------- | ---------- | -------- | -------------------------------------- |
| Platform | Selector   | -        | Select from a system we integrate with |
| API Key  | Text       | -        | If not empty the below fields show up  |

#### Payment Gateway Settings

| Field    | Input Type | Required | Notes                                                    |
| -------- | ---------- | -------- | -------------------------------------------------------- |
| Platform | Selector   | Required | Maps the payment gateway, this is required during set up |
| API Key  | Selector   | Required | -                                                        |

## Security

* Credentials encrypted at rest
* Decrypted only when needed for API calls
* Access logged in audit trail

## Features

### Integration Settings

#### Acceptance Criteria

##### Frontend

* [ ] Admin/client UI can view and manage `Integration Settings` records where applicable.

##### Backend / API

* [ ] CRUD operations exist for `Integration Settings` (create, read, update, delete/archive).

##### Permissions

* [ ] Access is restricted to appropriate roles (tenant-scoped).

##### Business Rules

* [ ] Fields and relationships documented on this page are enforced for `Integration Settings`.

##### Error Handling

* [ ] Invalid payloads return field-level validation errors.
