WEweld
Notifications

List Notifications

Changed on

List the active Notifications of the account in pages, sorted by creation date in descending order (most recent first). A Notification with is_lock set pauses the entity it concerns until it is removed. QUARANTINE Notifications carry a quarantine_explanation with the cause and the steps that clear it.

get/notifications

Request

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

Query parameters

starting_afterstring
Example:ewK8sDoLNI4CFR

The cursor to use in pagination. Use the value of the next_cursor field from the response of a previous list request.

limitinteger

The number of items to return in a single page.

Response

has_moreboolean required

Indicates whether there are more items to be fetched in the subsequent pages.

next_cursorstring

The cursor to use in pagination. Use this value as starting_after to get the next page.

Example response

{
  "has_more": true,
  "next_cursor": "VeN1GjhVIq1D9h",
  "data": [
    {
      "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