External Integration

Overview

As a user with system configuration privileges, you can manage external integrations to enable additional services in the system.

Adding Stripe Integration

To add a Stripe integration:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Click the "Add Integration" button.
3. Select "Stripe" from the list of available integrations.
4. Enter a name for the integration.
5. Enter the secret key for Stripe.
6. Toggle the switch to activate Stripe in the system.
7. Click the "Save Integration" button.
8. The Stripe integration will be added to the list of integrations and marked as active.
9. A confirmation message will indicate the integration has been added.

Editing Stripe Integration

To edit a Stripe integration:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Select the Stripe integration from the list.
3. Click the "Edit" button.
4. Change the name of the integration.
5. Change the secret key for Stripe.
6. Toggle the switch to activate or deactivate Stripe in the system.
7. Click the "Save Integration" button.
8. The changes to the Stripe integration will be saved.
9. A confirmation message will indicate the integration has been updated.

Deleting Stripe Integration

To delete a Stripe integration:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Select the Stripe integration from the list.
3. Click the "Delete" button.
4. A confirmation prompt will ask if you are sure you want to delete the integration.
5. Confirm the deletion.
6. The Stripe integration will be removed from the list of integrations.
7. A confirmation message will indicate the integration has been deleted.

Activating Stripe Integration

To activate a Stripe integration:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Ensure that the Stripe integration is added and currently deactivated.
3. Toggle the switch to activate Stripe in the system.
4. The Stripe integration will be marked as active.
5. A confirmation message will indicate the integration has been activated.

Deactivating Stripe Integration

To deactivate a Stripe integration:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Ensure that the Stripe integration is added and currently activated.
3. Toggle the switch to deactivate Stripe in the system.
4. The Stripe integration will be marked as inactive.
5. A confirmation message will indicate the integration has been deactivated.

Viewing Integration Details

To view details of an integration:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Select an integration from the list.
3. You will see the details of the integration, including the name and status.

Canceling Adding an Integration

To cancel adding an integration:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Click the "Add Integration" button.
3. Select "Stripe" from the list of available integrations.
4. Enter a name for the integration.
5. Enter the secret key for Stripe.
6. Click the "Cancel" button.
7. The integration will not be added.
8. You will be redirected back to the External Integration page without changes.

Handling Invalid Secret Key Error

To handle an invalid secret key error:

1. Log in as a user with system configuration privileges and go to the External Integration page.
2. Click the "Add Integration" button.
3. Select "Stripe" from the list of available integrations.
4. Enter an invalid secret key for Stripe.
5. Click the "Save Integration" button.
6. An error message will indicate the secret key is invalid.
7. The integration will not be added.