---
title: "Report the plugin's version and push address"
method: PUT
path: "/connection"
tags: ["Connection"]
---

# Report the plugin's version and push address

`PUT /connection`

## Request

- Base URL: `https://sitesplaced.com/api/v1`
- URL: `https://sitesplaced.com/api/v1/connection`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Connection key only. Permission `connection:manage`. A `site_url` whose host differs from the connected one gives 409 and the plugin must pause: this is how a staging copy of a site is stopped from sending orders to the live store.

## Request body

- ConnectionHeartbeat
  - `plugin_version` string
  - `platform_version` string
  - `site_url` string, uri: A host that differs from the connected one gives 409.
  - `push_url` string, nullable: Where SitesPlaced pushes updates. Null when the shop's REST API cannot be reached.
  - `shop_name` string
  - `currency` string

## Response `200`

The connection and its store.

- ConnectionStatus
  - `connection` Connection, required
    - `id` string, uuid, required
    - `platform` string, required
    - `status` string, required
    - `status_detail` string, nullable
    - `shop_url` string, nullable
    - `orders_synced` integer
    - `last_order_at` string, date-time, nullable
  - `store` ConnectedStore, required
    - `id` string, uuid, required
    - `name` string, required
    - `slug` string, required
    - `tracking_url` string, uri, required
    - `dashboard_url` string, uri, required

## Other responses

- `400`: `invalid_request`. The request is malformed or a field has a bad value; `param` names the field.
- `401`: `unauthorized`. The key is missing, wrong or revoked.
- `403`: `forbidden`. The key may not do this: a secret key sent from a browser, a publishable key from a website not on its list, the wrong kind of key, or a missing permission.
- `409`: `conflict`.
- `413`: `payload_too_large`. Bodies can be up to 1 MB.
- `429`: `rate_limited`. Wait for `Retry-After` seconds.
- `500`: `internal_error`.
- `503`: `unavailable`.

---

[API](https://skmtc.dev/sitesplaced/apis/sitesplaced-developer-api.md) · [All operations](https://skmtc.dev/sitesplaced/apis/sitesplaced-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sitesplaced/apis/sitesplaced-developer-api/revisions/66fbfbbaad1a?raw)