Connection error updated

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

object

required

Show child attributes

data.failed_url

string

required

The URL that failed.

Example:

"failed_url"

data.affected_endpoints

AffectedEndpoints · object[]

required

A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.

Show child attributes

data.affected_endpoints.endpoint

string

required

The endpoint that was affected.

Example:

"GET /wms/inventory"

data.affected_endpoints.preventing_sync

boolean

required

If True, the error is preventing the sync from completing. If False, we are able to sync but there may be data or fields that we are unable to fetch.

Example:

false

Example:

[
  {
    "endpoint": "GET /wms/inventory",
    "preventing_sync": true
  },
  {
    "endpoint": "GET /wms/orders",
    "preventing_sync": false
  }
]

data.integration_name

string

required

The name of the affected integration.

Example:

"integration_name"

data.error_message

string

required

The error message.

Example:

"Missing integration_name permissions for URL: failed_url."

data.created_date

string<date-time>

required

The date the connection error was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

required

The date the connection error was last updated.

Example:

"2022-01-02T05:05:05Z"

data.last_seen

string<date-time>

required

The last time this connection error was seen.

Example:

"2021-01-01T00:00:00Z"

event_type

string

required

Example:

"connection-error.updated"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"general"

previous_attributes

object

required

Show child attributes

previous_attributes.failed_url

string

required

The URL that failed.

Example:

"failed_url"

previous_attributes.affected_endpoints

AffectedEndpoints · object[]

required

A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.

Show child attributes

previous_attributes.affected_endpoints.endpoint

string

required

The endpoint that was affected.

Example:

"GET /wms/inventory"

previous_attributes.affected_endpoints.preventing_sync

boolean

required

If True, the error is preventing the sync from completing. If False, we are able to sync but there may be data or fields that we are unable to fetch.

Example:

false

Example:

[
  {
    "endpoint": "GET /wms/inventory",
    "preventing_sync": true
  },
  {
    "endpoint": "GET /wms/orders",
    "preventing_sync": false
  }
]

previous_attributes.integration_name

string

required

The name of the affected integration.

Example:

"integration_name"

previous_attributes.error_message

string

required

The error message.

Example:

"Missing integration_name permissions for URL: failed_url."

previous_attributes.created_date

string<date-time>

required

The date the connection error was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.updated_date

string<date-time>

required

The date the connection error was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.last_seen

string<date-time>

required

The last time this connection error was seen.

Example:

"2021-01-01T00:00:00Z"

Response

200

Success

Home

How-To Guides

Use Cases

Connection error updated

Body

Response