---
title: "Install failed"
method: POST
path: "install.failed"
---

# Install failed

`POST install.failed` (webhook)

When a customer's attempt to connect an integration fails before a connection is created.

## Payload

- union
  - GeneralFailedInstallsFailedFullWebhook
    - `connection_id` string, required
    - `data` FailedInstallSchema, required
      - `id` string, required: The unique id of the failed install attempt.
      - `integration_name` string, required: The integration the customer tried to connect.
      - `integration_type` string, required: The integration type (wms, cart, carrier, etc.).
      - `customer_id` string, nullable, required: Your identifier for the end customer who attempted the connection.
      - `link_token` string, required: The link token the install attempt was made with.
      - `error_message` string, required: Why the install failed.
      - `created_at` string, date-time, required: When the install attempt failed.
    - `event_type` 'install.failed', required
    - `integration_name` string, required
    - `integration_type` string, required
  - GeneralFailedInstallsFailedTruncatedWebhook
    - `connection_id` string, required
    - `data` GeneralFailedInstallsFailedTruncatedData, required
      - `id` string: The record this event is about. Absent on connection webhooks, which carry dates rather than a row.
    - `event_type` 'install.failed', required
    - `integration_name` string, required
    - `integration_type` string, required
    - `data_truncated` boolean, required: Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.
    - `data_url` string, required: Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.

## Acknowledgement `200`

Success

---

[API](https://skmtc.dev/trackstarhq/apis/trackstar-api.md) - [All operations](https://skmtc.dev/trackstarhq/apis/trackstar-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trackstarhq/apis/trackstar-api/revisions/08647f790594?raw)