Supaglue

https://github.com/supaglue-labs/supaglue
Admin
Supaglue is an open source developer platform for user-facing product integrations that helps B2B...
Tokens:353,302
Snippets:1,444
Trust Score:-
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start Development Services

Source: https://github.com/supaglue-labs/supaglue/blob/main/DEVELOPMENT.md

Launches the backend services via Docker and starts the management UI workspace.

```shell
docker compose up

yarn workspace mgmt-ui dev
```

--------------------------------

### Render IntegrationCard with Salesforce Details

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/tutorials/build-integration-card.mdx

Example of how to use the IntegrationCard component with specific Salesforce details. The 'to' prop is a placeholder in this initial setup.

```jsx
// SettingsPage.jsx

// applicationId: 8473e5ad-ffe7-45db-bbfd-ebc638f5f8c9
// customerId: 001
// providerName: salesforce
// returnUrl: https://supaglue.com

<IntegrationCard
  icon="/img/salesforce.svg"
  provider="Salesforce"
  description="Sync your leads to and from Salesforce"
  to="#"
/>
```

--------------------------------

### Sync Configuration JSON Example

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/mgmt/delete-sync-config.api.mdx

A complete example of a sync configuration payload, including default settings and object-specific overrides for common, standard, and custom objects.

```json
{
  "id": "465fdcb7-26b4-4090-894c-67cab41022bb",
  "application_id": "9572d08b-f19f-48cc-a992-1eb7031d3f6a",
  "destination_name": "postgres",
  "provider_name": "hubspot",
  "config": {
    "default_config": {
      "period_ms": 60000,
      "strategy": "full then incremental",
      "auto_start_on_connection": true,
      "full_sync_every_n_incrementals": 0
    },
    "common_objects": [
      {
        "object": "contact",
        "sync_strategy_override": {
          "period_ms": 60000,
          "strategy": "full then incremental",
          "auto_start_on_connection": true,
          "full_sync_every_n_incrementals": 0
        },
        "associations_to_fetch": [
          "account"
        ]
      }
    ],
    "standard_objects": [
      {
        "object": "Contact",
        "sync_strategy_override": {
          "period_ms": 60000,
          "strategy": "full then incremental",
          "auto_start_on_connection": true,
          "full_sync_every_n_incrementals": 0
        },
        "associations_to_fetch": [
          "account"
        ]
      }
    ],
    "custom_objects": [
      {
        "object": "MyCustomObject__c",
        "sync_strategy_override": {
          "period_ms": 60000,
          "strategy": "full then incremental",
          "auto_start_on_connection": true,
          "full_sync_every_n_incrementals": 0
        },
        "associations_to_fetch": [
          "account"
        ]
      }
    ]
  }
}
```

--------------------------------

### Customer Data Example

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/engagement/get-contact.api.mdx

This snippet shows an example of customer data as returned by the API.

```APIDOC
## Customer Data

### Description
This endpoint returns detailed information about a customer, including contact details, addresses, and engagement metrics.

### Method
GET

### Endpoint
`/api/customers/{customer_id}`

### Parameters
#### Path Parameters
- **customer_id** (string) - Required - The unique identifier for the customer.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the customer.
- **first_name** (string) - The customer's first name.
- **last_name** (string) - The customer's last name.
- **job_title** (string) - The customer's job title.
- **address** (object[]) - An array of address objects.
  - **street_1** (string) - The primary street address.
  - **street_2** (string | null) - The secondary street address (optional).
  - **city** (string) - The city.
  - **state** (string) - The state or province.
  - **postal_code** (string) - The postal code.
  - **country** (string) - The country.
- **email_addresses** (object[]) - An array of email address objects.
  - **email_address** (string) - The email address.
  - **email_address_type** (string) - The type of email address (e.g., 'work', 'personal').
- **phone_numbers** (object[]) - An array of phone number objects.
  - **phone_number** (string) - The phone number.
  - **phone_number_type** (string) - The type of phone number (e.g., 'work', 'mobile').
- **open_count** (integer) - The number of emails opened by the customer.
- **click_count** (integer) - The number of links clicked by the customer.
- **reply_count** (integer) - The number of emails replied to by the customer.
- **bounced_count** (integer) - The number of emails that bounced.
- **created_at** (string) - The timestamp when the customer record was created.
- **updated_at** (string) - The timestamp when the customer record was last updated.
- **is_deleted** (boolean) - Indicates if the customer record is deleted.
- **last_modified_at** (string) - The timestamp of the last modification.
- **raw_data** (object) - Any additional raw data associated with the customer.

### Response Example
```json
{
  "id": "cus_12345",
  "first_name": "George",
  "last_name": "Xing",
  "job_title": "CEO",
  "address": [
    {
      "street_1": "525 Brannan",
      "street_2": null,
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94107",
      "country": "US"
    }
  ],
  "email_addresses": [
    {
      "email_address": "hello@supaglue.com",
      "email_address_type": "work"
    }
  ],
  "phone_numbers": [
    {
      "phone_number": "+14151234567",
      "phone_number_type": "work"
    }
  ],
  "open_count": 0,
  "click_count": 0,
  "reply_count": 0,
  "bounced_count": 0,
  "created_at": "2022-02-27T00:00:00Z",
  "updated_at": "2022-02-27T00:00:00Z",
  "is_deleted": false,
  "last_modified_at": "2022-02-27T00:00:00Z",
  "raw_data": {}
}
```
```

--------------------------------

### Response Example: List Entities

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/mgmt/get-sync-runs.api.mdx

Example response structure for listing entities.

```APIDOC
## Response Example: List Entities

```json
{
  "next": "eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ==",
  "previous": "eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9",
  "total_count": 100,
  "results": [
    {
      "id": "20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9",
      "sync_id": "629525f8-f6f7-436c-80fa-1cb23acc5bf8",
      "object_type": "common",
      "object": "string",
      "error_message": "string",
      "start_timestamp": "2023-02-22T19:55:17.559537Z",
      "end_timestamp": "2023-02-22T20:55:17.559537Z",
      "application_id": "974125fa-ffb6-47fc-b12f-44c566fc5da1",
      "customer_id": "my-customer-1",
      "provider_name": "hubspot",
      "category": "crm",
      "connection_id": "3217ea51-11c8-43c9-9547-6f197e02e5e4",
      "status": "SUCCESS",
      "num_records_synced": 100
    }
  ]
}
```
```

--------------------------------

### GET /customers

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/mgmt/get-customers.api.mdx

Retrieves a list of customers from the system.

```APIDOC
## GET /customers

### Description
Get a list of customers.

### Method
GET

### Endpoint
/customers
```

--------------------------------

### Initialize Development Environment

Source: https://github.com/supaglue-labs/supaglue/blob/main/DEVELOPMENT.md

Executes the setup script to prepare the local development environment.

```shell
./scripts/setup_dev_env.sh
```

--------------------------------

### Run Development Server

Source: https://github.com/supaglue-labs/supaglue/blob/main/apps/mgmt-ui/README.md

Execute these commands to start the local development server for the Next.js project. Open http://localhost:3000 in your browser to view the application.

```bash
npm run dev
```

```bash
yarn dev
```

```bash
pnpm dev
```

--------------------------------

### Associations Response Example

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/crm/list-associations.api.mdx

Example JSON response structure for a successful associations request.

```json
{
  "results": [
    {
      "association_schema_id": "string",
      "source_object": "company",
      "source_record_id": "45636a40-87e3-4707-b43c-39fecf9a8f4b",
      "target_object": "contact",
      "target_record_id": "ad204784-a71b-440a-8482-c3d5ab64110f"
    }
  ]
}
```

--------------------------------

### Create Connection (API Key Auth)

Source: https://context7.com/supaglue-labs/supaglue/llms.txt

Establishes a connection for a customer using API key authentication for a specific provider. Ensure the provider is configured and the API key is valid.

```bash
curl -X POST "https://api.supaglue.io/mgmt/v2/customers/customer-123/connections" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "provider_name": "apollo",
    "credentials": {
      "api_key": "apollo-api-key-here"
    }
  }'
```

--------------------------------

### Error Response Example

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/mgmt/delete-connection.api.mdx

This snippet shows an example of an error response from the API, detailing validation issues.

```APIDOC
## Error Response Example

### Description
This endpoint returns an error response when property values are not valid, indicating a validation failure.

### Response
#### Success Response (400)
- **errors** (array) - An array containing details about the validation errors.
  - **meta** (object) - Metadata about the error.
    - **cause** (object) - The underlying cause of the error.
      - **code** (integer) - The HTTP status code.
      - **body** (object) - The error response body.
        - **status** (string) - The status of the error (e.g., "error").
        - **message** (string) - A detailed error message.
        - **correlationId** (string) - A unique identifier for the request.
        - **category** (string) - The category of the error (e.g., "VALIDATION_ERROR").
      - **headers** (object) - The response headers.
  - **detail** (string) - A detailed description of the validation error.
  - **problem_type** (string) - The type of problem encountered (e.g., "MISSING_REQUIRED_FIELD").
  - **title** (string) - A title for the error.
  - **code** (string) - An error code.
  - **status** (string) - The HTTP status code as a string.
  - **id** (string) - A unique identifier for the specific error instance.

### Response Example
```json
{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}
```
```

--------------------------------

### API Authentication Example

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/introduction.mdx

Demonstrates how to authenticate requests to the Supaglue API using an API key.

```APIDOC
## API Authentication

Your requests to the Supaglue API must contain an API key. You can generate an API key in the Management Portal on the Settings -> API Key page.

Pass in the API key in requests to the Supaglue API as a header:

```curl
curl http://api.supaglue.io/crm/v2/contacts \
   -H 'x-api-key: ...'
```

:::info

You will only be able to view the API key upon generation. Store it in a safe place.

When you regenerate an API key, the previous key is invalidated.
:::

```

--------------------------------

### Run Supaglue Locally

Source: https://context7.com/supaglue-labs/supaglue/llms.txt

Commands to clone, configure, and start the Supaglue platform using Docker Compose.

```bash
# Clone and start Supaglue
git clone -b v0.25.7 https://github.com/supaglue-labs/supaglue.git
cd supaglue

# Create environment configuration
./scripts/create_quickstart_env.sh

# Start all services
docker compose up
```

--------------------------------

### Error Response Example

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/crm/create-standard-object-record.api.mdx

This snippet shows an example of an error response from the Supaglue API, detailing validation errors.

```APIDOC
## Error Response Example

### Description
This endpoint returns an error response when property values are not valid, indicating a validation failure.

### Method
POST (or other relevant method, inferred from context)

### Endpoint
/api/some/endpoint (inferred from context)

### Response
#### Error Response (400)
- **errors** (array) - An array containing error details.
  - **meta** (object) - Metadata about the error.
    - **cause** (object) - Details of the underlying cause of the error.
      - **code** (integer) - The HTTP status code associated with the error.
      - **body** (object) - The response body from the service that caused the error.
        - **status** (string) - The status of the error (e.g., "error").
        - **message** (string) - A detailed message explaining the error.
        - **correlationId** (string) - A unique identifier for correlating requests.
        - **category** (string) - The category of the error (e.g., "VALIDATION_ERROR").
      - **headers** (object) - The headers from the service that caused the error.
  - **detail** (string) - A human-readable description of the validation error.
  - **problem_type** (string) - The type of problem encountered (e.g., "MISSING_REQUIRED_FIELD").
  - **title** (string) - A title for the error.
  - **code** (string) - An error code.
  - **status** (string) - The HTTP status code.
  - **id** (string) - A unique identifier for the error.

### Response Example
```json
{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}
```
```

--------------------------------

### Error Handling and Response Examples

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/mgmt/create-sync-config.api.mdx

This section details common error responses and provides examples for understanding API behavior during failures.

```APIDOC
## Error Handling

This API returns detailed error information to help diagnose issues.

### Common Error Codes

- **400 Bad Request**: Indicates a problem with the request payload, such as invalid field values or missing required fields.
- **422 Unprocessable Entity**: Used when the request is syntactically correct but semantically incorrect, often due to validation errors.

### Response Example (400 Bad Request)

```json
{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}
```

### Response Example (422 Unprocessable Entity)

```json
{
  "errors": [
    {
      "message": "Unprocessable Entity",
      "status": 422
    }
  ]
}
```
```

--------------------------------

### Example SyncConfig JSON

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/integration-patterns/managed-syncs.mdx

This JSON defines a SyncConfig, referencing a Salesforce Provider and a Postgres Destination. It specifies which standard and custom objects to sync.

```json
{
  "id": "...",
  "application_id": "...",
  "provider_id": "7f72ec07-e5c1-47fd-8cf5-e71dd13873af",
  "destination_id": "6e7baa88-84dd-4dbc-902a-14522c2984eb",
  "config": {
    "default_config": {
      "period_ms": 60000,
      "strategy": "full then incremental",
      "auto_start_on_connection": true
    },
    "standard_objects": [
      {
        "object": "Account"
      }
    ],
    "custom_objects": [
      {
        "object": "Car__c"
      }
    ]
  }
}
```

--------------------------------

### Example Error Response

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/crm/get-custom-object-record.api.mdx

An example of a detailed error response that might be returned by the API, illustrating the structure and content of the error object.

```APIDOC
### Example Error Response

```json
{
  "cause": {
    "code": 400,
    "body": {
      "status": "error",
      "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
      "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
      "category": "VALIDATION_ERROR"
    },
    "headers": {
      "access-control-allow-credentials": "false",
      "cf-cache-status": "DYNAMIC",
      "cf-ray": "8053d17b9dae9664-SJC",
      "connection": "close",
      "content-length": "361",
      "content-type": "application/json;charset=utf-8",
      "date": "Mon, 11 Sep 2023 23:51:22 GMT",
      "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
      "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
      "server": "cloudflare",
      "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
      "vary": "origin, Accept-Encoding",
      "x-content-type-options": "nosniff",
      "x-envoy-upstream-service-time": "91",
      "x-evy-trace-listener": "listener_https",
      "x-evy-trace-route-configuration": "listener_https/all",
      "x-evy-trace-route-service-name": "envoyset-translator",
      "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
      "x-evy-trace-virtual-host": "all",
      "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
      "x-hubspot-ratelimit-interval-milliseconds": "10000",
      "x-hubspot-ratelimit-max": "100",
      "x-hubspot-ratelimit-remaining": "99",
      "x-hubspot-ratelimit-secondly": "10",
      "x-hubspot-ratelimit-secondly-remaining": "9",
      "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
      "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
    }
  },
  "origin": "remote-provider",
  "application_name": "MyCompany Production"
}
```
```

--------------------------------

### Error Handling and Response Examples

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/crm/list-accounts.api.mdx

This section details common error responses and provides examples for understanding API behavior under different conditions.

```APIDOC
## Error Responses

### 400 Bad Request

This error typically indicates that the request sent by the client was malformed or contained invalid data, such as incorrect property values or missing required fields.

#### Response Example (400)
```json
{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}
```

### 403 Forbidden

This error indicates that the client does not have the necessary permissions to access the requested resource.

#### Response Example (403)
```
Forbidden
```
```

--------------------------------

### Configure Postgres Database Grants

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/destinations/postgres.md

SQL commands to create a dedicated schema and role for Supaglue with necessary permissions.

```sql
create schema supaglue;

create role supaglue_role;
grant connect on database <your db name> to supaglue_role;
grant all privileges on schema supaglue to supaglue_role;
grant all privileges on all tables in schema supaglue to supaglue_role;
alter default privileges in schema supaglue grant all privileges on tables to supaglue_role;
grant supaglue_role to supaglue_user;
```

--------------------------------

### API Validation Error Response Example

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/crm/get-contact.api.mdx

Example of a 400 Bad Request response containing detailed validation error information and correlation IDs.

```json
{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\",\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}
```

--------------------------------

### POST /sync/config

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/api/v2/mgmt/get-connection-sync-config.api.mdx

Configure connection sync settings, including destination configurations and standard objects to sync.

```APIDOC
## POST /sync/config

### Description
Configure connection sync settings, including destination configurations and standard objects to sync.

### Method
POST

### Endpoint
/sync/config

### Parameters
#### Header Parameters
- **x-customer-id** (string) - Required - The customer ID that uniquely identifies the customer in your application
- **x-provider-name** (string) - Required - The provider name

### Request Body
- **destination_config** (object) - Optional - An object to override the default Destination configuration per connection.
  - **type** (string) - Required - Possible values: [`postgres`]
  - **schema** (string) - Required - The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.
  - **type** (string) - Required - Possible values: [`bigquery`]
  - **dataset** (string) - Required - The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.
- **standard_objects** (object[]) - Optional - A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.

### Response
#### Success Response (200)
- **destination_config** (object) - An object to override the default Destination configuration per connection.
- **standard_objects** (object[]) - A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.

#### Response Example
{
  "destination_config": {
    "type": "postgres",
    "schema": "customer_1_schema"
  },
  "standard_objects": [
    {
      "id": "object_1"
    }
  ]
}
```

--------------------------------

### Send Passthrough GET Request to HubSpot

Source: https://context7.com/supaglue-labs/supaglue/llms.txt

Sends a direct GET request to the HubSpot API for retrieving schemas. Useful for accessing provider-specific functionality.

```bash
# Base URL: https://api.supaglue.io/actions/v2

# Send a passthrough request to HubSpot
curl -X POST "https://api.supaglue.io/actions/v2/passthrough" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-customer-id: customer-123" \
  -H "x-provider-name: hubspot" \
  -d '{
    "path": "/crm/v3/schemas",
    "method": "GET",
    "headers": {},
    "query": {}
  }'
```

--------------------------------

### Create Provider Configuration

Source: https://context7.com/supaglue-labs/supaglue/llms.txt

Configures a new provider (e.g., Salesforce, HubSpot) for your application, including authentication type and sync settings. This is essential before creating connections.

```bash
curl -X POST "https://api.supaglue.io/mgmt/v2/providers" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "salesforce",
    "category": "crm",
    "auth_type": "oauth2",
    "config": {
      "oauth": {
        "oauth_scopes": ["api", "refresh_token", "offline_access"],
        "credentials": {
          "oauth_client_id": "your-salesforce-client-id",
          "oauth_client_secret": "your-salesforce-client-secret"
        }
      },
      "sync": {
        "period_ms": 3600000
      }
    }
  }'
```

--------------------------------

### Enable Prisma Views Preview Feature

Source: https://github.com/supaglue-labs/supaglue/blob/main/docs/versioned_docs/version-0.25.7/tutorials/mongo-view-prisma-view.md

Configure your `schema.prisma` file to enable the 'views' preview feature for Prisma. This allows Prisma to generate a client that can interact with database views.

```prisma
generator client {
  provider        = "prisma-client-js"
  // enable views
  previewFeatures = ["views"]
}
```
Tokens:
Raw