transfer_created

Occurs when an overall transfer is created. Different applications decide at different times when transfers are created, but generally: a transfer_created event is sent when a transfer or job has been started (e.g. transferring 2 sources to one destination sends two transfer_created events).

Example event

This example event is showing OffShoot finishing the transfer of one source (in this example: A001) to two destinations (RAID, NAS ).

{
  "version": 1,
  "event": "transfer_created",
  "transfer": {
    "id": "y7opjyv9jl4w",
    "external_id": "de1efd56-7d53-4211-b798-21f5eb2db2be",
    "client_id": "e85j1l6r13nq",
    "uploaded_size": 0,
    "total_size": 10000000000,
    "progress": 0,
    "time_remaining": 0,
    "state": "queued",
    "source": {
      "id": "35qwe2eqwzdo",
      "external_id": "22f844e2-657c-3efe-8105-ce035d196288",
      "client_id": "e85j1l6r13nq",
      "name": "A001",
      "kind": "SD",
      "type": "source"
    },
    "transfers": [
      {
        "id": "6g5vq8lojolp",
        "external_id": "51d1707f-fd3d-413b-9e51-f4e15de31160",
        "client_id": "e85j1l6r13nq",
        "parent_id": "y7opjyv9jl4w",
        "uploaded_size": 0,
        "total_size": 5000000000,
        "upload_speed": 0,
        "progress": 0,
        "time_remaining": 0,
        "state": "queued",
        "source": {
          "id": "35qwe2eqwzdo",
          "external_id": "22f844e2-657c-3efe-8105-ce035d196288",
          "client_id": "e85j1l6r13nq",
          "name": "A001",
          "kind": "SD",
          "type": "source"
        },
        "destination": {
          "id": "dqxj87mn83k6",
          "external_id": "e5ea51a0-aa3d-4664-b40b-a662db546c41",
          "client_id": "e85j1l6r13nq",
          "name": "NAS",
          "kind": "HDD",
          "type": "destination"
        },
        "created_at": "2025-08-25T15:28:36.000000Z",
        "updated_at": "2025-08-25T15:28:36.000000Z"
      },
      {
        "id": "4nx1q78lj853",
        "external_id": "0b84a53f-ae25-4869-99ea-e19426bf2696",
        "client_id": "e85j1l6r13nq",
        "parent_id": "y7opjyv9jl4w",
        "uploaded_size": 0,
        "total_size": 5000000000,
        "upload_speed": 0,
        "progress": 0,
        "time_remaining": 0,
        "state": "queued",
        "source": {
          "id": "35qwe2eqwzdo",
          "external_id": "22f844e2-657c-3efe-8105-ce035d196288",
          "client_id": "e85j1l6r13nq",
          "name": "A001",
          "kind": "SD",
          "type": "source"
        },
        "destination": {
          "id": "0ogpvg77vqjn",
          "external_id": "08b2432f-a898-418e-a539-8051f7c2d3b9",
          "client_id": "e85j1l6r13nq",
          "name": "RAID",
          "kind": "HDD",
          "type": "destination"
        },
        "created_at": "2025-08-25T15:28:36.000000Z",
        "updated_at": "2025-08-25T15:28:36.000000Z"
      }
    ],
    "created_at": "2025-08-25T15:28:36.000000Z",
    "updated_at": "2025-08-25T15:28:36.000000Z"
  }
}

Event data

Field	Type	Description
version	int	The version number of the event (for future changes)
event	enum	The type of event, in this case: transfer_created
transfer	object	See Transfer Group data

Transfer Group data

The transfer group wraps the transfers that are coming from the same source. This object looks similar to the transfer data below, but summarizes the stats from all transfers from the same source.

Field	Type	Description
id	string	The unique identifier for the given transfer
external_id	string	The unique identifier given by the application
client_id	string	The unique identifier for the Connect client
uploaded_size	int	The total summary of the size in bytes transferred by all the transfers within this group
total_size	int	The total summary of the total size in bytes by all the transfers within this group
progress	float	The total summary of the progress percentage by all the transfers within this group
time_remaining	int	The time remaining of the highest time remaining by al the transfers within this group
state	enum	Possible values of: unknown, queued, preparing, waiting_for_codex, transferring, canceling, canceled, finishing, completed, completed_with_warnings, stopped, failed, stale
transfers	Transfer[]	An array of Transfer data
created_at	string	The creation timestamp of the given transfer group in ISO8601 format
updated_at	string	The updated timestamp of the given transfer group in ISO8601 format

Transfer data

The individual transfers from one source to one destination.

Field	Type	Description
id	string	The unique identifier for the given transfer
external_id	string	The unique identifier given by the application
client_id	string	The unique identifier for the Connect client
parent_id	string|null	The unique identifier for the Transfer Group this transfer belongs to
uploaded_size	int	The total size in bytes that has been transferred
total_size	int	The total size in bytes for the given transfer
upload_speed	int	The upload speed in bytes per second
progress	float	The percentage of progress for the given transfer
time_remaining	int	The estimated amount of seconds remaining from now until the transfer has been completed
state	enum	Possible values of: unknown, queued, preparing, waiting_for_codex, transferring, canceling, canceled, finishing, completed, completed_with_warnings, stopped, failed, stale
source	object	Optional. See Source & Destination
destination	object	Optional. See Source & Destination
created_at	string	The creation timestamp of the given transfer in ISO8601 format
updated_at	string	The last updated at timestamp of the given transfer in ISO8601 format

Source & Destination

Field	Type	Description
id	string	The unique identifier of the source or destination
external_id	string	The unique identifier given by the application
client_id	string	The unique identifier for the Connect client
name	string	The display name of the source or destination
kind	string	The kind of source or destination
type	enum	Possible values of: source, destination