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

# Heroku sync

> Learn how to configure a Heroku Sync for Infisical.

**Prerequisites:**

* Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
* Create a [Heroku Connection](https://infisical.com/docs/integrations/app-connections/heroku.md)

> [tab] Infisical UI
>
> 1. Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Select the **Add Sync** button.
>
>    ![Secret Syncs Tab](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/general/secret-sync-tab.png)
>
> 2. Select the **Heroku** option.
>
>    ![Select Heroku](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/heroku/select-heroku-option.png)
>
> 3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
>
>    ![Configure Source](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/heroku/heroku-source.png)
>
>    * **Environment**: The project environment to retrieve secrets from.
>
>    * **Secret Path**: The folder path to retrieve secrets from.
>
> > [!TIP]
> >
> > If you need to sync secrets from multiple folder locations, check out [secret imports](https://infisical.com/docs/documentation/platform/secret-reference.md#secret-imports).
>
> 4. Configure the **Destination** to where secrets should be deployed, then click **Next**.
>
>    ![Configure Destination](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/heroku/heroku-destination.png)
>
>    * **Heroku Connection**: The Heroku Connection to authenticate with.
>    * **Heroku App**: The Heroku application to sync secrets to.
>
> 5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
>
>    ![Configure Options](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/heroku/heroku-options.png)
>
>    * **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
>      * **Import - Prefer values from Infisical**: Import secrets from Heroku to Infisical; if a secret with the same name already exists in Infisical, do nothing. Afterwards, sync secrets to Heroku.
>      * **Import - Prefer values from Heroku**: Import secrets from Heroku to Infisical; if a secret with the same name already exists in Infisical, replace its value with the one from Heroku. Afterwards, sync secrets to Heroku.
>      * **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
>
>    * **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name and `{{environment}}` for the environment.
>
>    > [!NOTE]
>    >
>    > We highly recommend using a Key Schema to ensure that Infisical only manages the specific keys you intend, keeping everything else untouched.
>
>    * **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
>    * **Disable Secret Deletion**: If enabled, Infisical will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Infisical.
>
> 6. Configure the **Details** of your Heroku Sync, then click **Next**.
>
>    ![Configure Details](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/heroku/heroku-details.png)
>
>    * **Name**: The name of your sync. Must be slug-friendly.
>    * **Description**: An optional description for your sync.
>
> 7. Review your Heroku Sync configuration, then click **Create Sync**.
>
>    ![Confirm Configuration](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/heroku/heroku-review.png)
>
> 8. If enabled, your Heroku Sync will begin syncing your secrets to the destination endpoint.
>
>    ![Sync Secrets](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/heroku/heroku-created.png)

> [tab] API
>
> To create a **Heroku Sync**, make an API request to the [Create Heroku Sync](https://infisical.com/docs/api-reference/endpoints/secret-syncs/heroku/create.md) API endpoint.
>
> ### Sample request
>
> ```bash Request theme={"dark"}
> curl    --request POST \
> --url https://app.infisical.com/api/v1/secret-syncs/heroku \
> --header 'Content-Type: application/json' \
> --data '{
>     "name": "my-heroku-sync",
>     "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>     "description": "an example sync",
>     "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>     "environment": "dev",
>     "secretPath": "/my-secrets",
>     "isEnabled": true,
>     "syncOptions": {
>         "initialSyncBehavior": "overwrite-destination",
>         "disableSecretDeletion": true
>     },
>     "destinationConfig": {
>         "app": "8dd25736052a4b50",
>         "appName": "my-app"
>     }
> }'
> ```
>
> ### Sample response
>
> ```bash Response theme={"dark"}
> {
>     "secretSync": {
>         "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "name": "my-heroku-sync",
>         "description": "an example sync",
>         "isEnabled": true,
>         "version": 1,
>         "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "createdAt": "2023-11-07T05:31:56Z",
>         "updatedAt": "2023-11-07T05:31:56Z",
>         "syncStatus": "succeeded",
>         "lastSyncJobId": "123",
>         "lastSyncMessage": null,
>         "lastSyncedAt": "2023-11-07T05:31:56Z",
>         "importStatus": null,
>         "lastImportJobId": null,
>         "lastImportMessage": null,
>         "lastImportedAt": null,
>         "removeStatus": null,
>         "lastRemoveJobId": null,
>         "lastRemoveMessage": null,
>         "lastRemovedAt": null,
>         "syncOptions": {
>             "initialSyncBehavior": "overwrite-destination",
>             "disableSecretDeletion": true
>         },
>         "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>         "connection": {
>             "app": "heroku",
>             "name": "my-heroku-connection",
>             "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
>         },
>         "environment": {
>             "slug": "dev",
>             "name": "Development",
>             "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
>         },
>         "folder": {
>             "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
>             "path": "/my-secrets"
>         },
>         "destination": "heroku",
>         "destinationConfig": {
>             "app": "8dd25736052a4b50",
>             "appName": "my-app"
>         }
>     }
> }
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.