---
title: "Create an integration"
method: POST
path: "/api/integrations"
tags: ["Integrations"]
---

# Create an integration

`POST /api/integrations`

Create an integration e.g. with Plaid

## Request body

- object
  - `integration` IntegrationSchema
    - `base_url` string, url, nullable — Base URL of the API integration. For Google Drive, use root_dir_path in client_auth instead.
    - `client_auth` object — Client-specific authentication settings depending on the integration type
    - `client_id` string, nullable — Client ID for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
    - `client_secret` string, nullable — Client Secret for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
    - `heron_id` string
    - `name` string, required — A name for your integration
    - `resource` 'transaction' | 'assets_report' | 'end_user_application' | 'invoice_factoring_processing' | 'end_user_files' | 'funder_decision', required — For integrations with multiple available resources, the specific resource
    - `type` string, required — The integration type, a specific provider
    - `webhook_url` string, url, nullable — URL provided by you to which we'll forward all webhooks (optional)

## Response `201`

Created

- object
  - `integration` IntegrationSchema
    - `base_url` string, url, nullable — Base URL of the API integration. For Google Drive, use root_dir_path in client_auth instead.
    - `client_auth` object — Client-specific authentication settings depending on the integration type
    - `client_id` string, nullable — Client ID for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
    - `client_secret` string, nullable — Client Secret for API access (this is encrypted in transit and at-rest with a custom key). Required for Plaid integration
    - `heron_id` string
    - `name` string, required — A name for your integration
    - `resource` 'transaction' | 'assets_report' | 'end_user_application' | 'invoice_factoring_processing' | 'end_user_files' | 'funder_decision', required — For integrations with multiple available resources, the specific resource
    - `type` string, required — The integration type, a specific provider
    - `webhook_url` string, url, nullable — URL provided by you to which we'll forward all webhooks (optional)

---

[API](https://skmtc.net/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.net/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/herondata/heron-data-api/versions/f2e441edece2/schema)