**Source URL:** https://ecoa.veevavault.help/en/gr/918797/index.md

# Working with Outbound APIs

You can manage API credentials and monitor the status of outbound data transfers from the Exports tab.

## Managing API Credentials

You must configure unique credentials for both Production and UAT environments to ensure data flows to the correct system. You can access these settings in the **Outbound API** section of the **Exports** tab.

Veeva recommends creating a dedicated Vault user account specifically for exports and integrations. A separate user account prevents you from being locked out of your personal vault account if the stored credentials become incorrect or stale. If the system fails to authenticate a CDB Export Job once, it will automatically disable the stored credentials for that job and alert the Veeva team of the authentication failure. A Veeva representative will notify the user that their credentials have been disabled and should be updated to resume the job.

### Adding Credentials {#adding-credentials}

Complete the following steps to create new API credentials:

1. In Studio, open the **Exports** tab and select **Outbound API**.
2. Select **Add Credentials** to open the configuration drawer.
3. Enter a Credential Label. This name will be displayed in the rule selection lists.
4. Enter the Username and Password for the Veeva EDC integration.
5. Enter the **Vault Subdomain**. For more information on the Vault Subdomain, see the <a class="external-link " href="https://developer-cdms.veevavault.com/api/" target="_blank" rel="noopener">Clinical Data EDC API help<i class="fa fa-external-link" aria-hidden="true"></i></a>.
6. (Optional) Select **Test**. You must enter a Username, Password, and Vault Subdomain to enable this action. The system attempts an authentication call and returns a success or failure message.
7. Select **Rules to Connect**. This list displays all rules with an API Call action that are not currently connected to another credential.
8. Select **Save**.

### Deactivating and Activating Credentials

You can deactivate a credential to immediately stop API calls for all connected rules.

1. Select the **Edit** icon for the target credential.
2. Select **Deactivate Credential** at the bottom of the drawer.
3. Confirm the action in the dialog.

To reactivate a credential:

1. Select **Edit** on an inactive credential.
2. Select **Activate Credential**.
3. Select the rules you want to connect.
4. Select **Save**.

## Monitoring Outbound API Logs

You can view a log of all external API calls to verify data transfers and troubleshoot errors. The log table displays a summary of calls for each day.

### Accessing Logs

1. Navigate to the **Exports** tab.
2. Select **Outbound API**.
3. Scroll to the **Outbound API Log** table.

### Generating and Downloading Logs

Each row in the table represents a single day of API activity (UTC). The table indicates if **Success**, **Failure**, or **Exception** responses occurred on that day.

To download the detailed log:

1. Locate the row for the date you want to review.
2. Select the **Download** icon.

When the file is ready, it will be downloaded as a .ZIP file containing the JSON response logs.

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: If the study includes restricted data, you must have the appropriate restricted data permissions to download the file.</p>
    </div>
  </div>
</div>



## Understanding Log Statuses

The following statuses are displayed in the API Log and the check event log to indicate the result of a rule-triggered API call:

* **Pending:** The system has initiated the call, but it has not yet received a response from the external system.
* **Success:** The external system successfully received the data and returned a success response.
* **Failure:** The API call failed to complete. This may occur due to incorrect credentials, an invalid Vault subdomain, or target fields missing in the external system.

## UAT and Production Environments

Credentials do not copy between environments. You must create separate credentials in the Sandbox environment for UAT testing. This ensures that test data does not affect your Production EDC study.

## Related Resources

* <a href="/en/gr/918799/">Creating a Send Survey Data Rule Template</a>
* <a href="/en/gr/918798/">Configuring Outbound API Field Mapping</a>