WEweld
Notifications

Get Notification

Changed on

Get a specific active Notification by its ID.

get/notifications/{id}

Request

  • Base URL
    https://connect.weld.app
  • URL
    https://connect.weld.app/notifications/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:Vb3kQ9xLm2Pt7a

The ID of the Notification.

Response

idstring required

The ID of the Notification.

typestring required

The kind of issue the Notification reports.

level'ERROR' | 'INFO' | 'WARNING' required

The severity of the Notification.

messagestring required

A short plain-text description of the issue.

entity_type'ACCOUNT' | 'CONNECTION' | 'ELT_STREAM' | 'ELT_SYNC' | 'ORCHESTRATION' | 'OTHER' | 'REVERSE_ETL_SYNC' | 'TRANSFORM' required

The kind of resource the Notification concerns. OTHER covers notifications about something the API does not expose, and syncs that no longer exist.

elt_stream_idstring nullable required

The ID of the ELT Stream the Notification concerns. Set when entity_type is ELT_STREAM and the stream still exists.

elt_sync_idstring nullable required

The ID of the ELT Sync the Notification concerns. Set when entity_type is ELT_SYNC, and with elt_stream_id for ELT_STREAM.

reverse_etl_sync_idstring nullable required

The ID of the Reverse ETL Sync the Notification concerns. Set when entity_type is REVERSE_ETL_SYNC.

connection_idstring nullable required

The ID of the Connection the Notification concerns. Set when entity_type is CONNECTION.

orchestration_idstring nullable required

The ID of the Orchestration the Notification concerns. Set when entity_type is ORCHESTRATION.

transform_idstring nullable required

The ID of the Transform the Notification concerns. Set when entity_type is TRANSFORM.

entity_namestring

A human-readable name of the entity.

is_dismissableboolean required

Whether the Notification can be removed. Other Notifications are removed once the issue is resolved.

is_lockboolean required

Whether the Notification pauses the entity until it is removed.

created_atstring date-time required

The datetime the Notification was created.

last_occurred_atstring date-time required

The datetime the issue was last reported.

expires_atstring date-time

The datetime the Notification is removed automatically, if it expires.

Example response

{
  "id": "Vb3kQ9xLm2Pt7a",
  "type": "QUARANTINE",
  "message": "The orders stream was paused after repeated failures.",
  "elt_stream_id": "j5SBQmcS4kLp2X",
  "elt_sync_id": "oux8StOd3mQz1v",
  "reverse_etl_sync_id": "OoORhGXUVjsqFG",
  "connection_id": "zYk2Lq0bVn8wRt",
  "orchestration_id": "3LIw2FdxoByya9",
  "transform_id": "mK4tRz8WqLp1Yb",
  "entity_name": "orders",
  "is_dismissable": true,
  "created_at": "2024-01-01T00:00:00.000Z",
  "last_occurred_at": "2024-01-02T00:00:00.000Z",
  "expires_at": "2024-01-08T00:00:00.000Z",
  "quarantine_explanation": {
    "headline": "Access revoked",
    "summary": "Shopify rejected the stored credentials, so the orders stream stopped syncing.",
    "actions": [
      {
        "detail": "Reconnect the Shopify connection, as its access token was revoked."
      }
    ],
    "generated_at": "2024-01-01T00:05:00.000Z"
  }
}

Changes