Klaviyo · Schema

WebFeedResponseObjectResource

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string Primary key that uniquely identifies this web feed. Generated by Klaviyo
attributes object
links object
View JSON Schema on GitHub

JSON Schema

klaviyo-webfeedresponseobjectresource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebFeedResponseObjectResource",
  "title": "WebFeedResponseObjectResource",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/WebFeedEnum"
    },
    "id": {
      "description": "Primary key that uniquely identifies this web feed. Generated by Klaviyo",
      "type": "string",
      "example": "925e385b52fb"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "name": {
          "description": "The name of this web feed",
          "type": "string",
          "example": "Blog_posts"
        },
        "url": {
          "description": "The URL of the web feed",
          "type": "string",
          "example": "https://help.klaviyo.com/api/v2/help_center/en-us/articles.json"
        },
        "request_method": {
          "description": "The HTTP method for requesting the web feed",
          "type": "string",
          "example": "get",
          "enum": [
            "get",
            "post"
          ]
        },
        "content_type": {
          "description": "The content-type of the web feed",
          "type": "string",
          "example": "json",
          "enum": [
            "json",
            "xml"
          ]
        },
        "created": {
          "description": "Date and time when the web feed was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00"
        },
        "updated": {
          "description": "Date and time when the web feed was updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00"
        },
        "status": {
          "description": "The cache status of this web feed if it exists",
          "type": "string",
          "example": "ok",
          "enum": [
            "critical_nightly_refresh_timeout",
            "disabled",
            "ok",
            "refreshing",
            "warning_nightly_refresh_timeout",
            "warning_periodic_refresh_timeout"
          ],
          "nullable": true
        }
      },
      "required": [
        "name",
        "url",
        "request_method",
        "content_type",
        "created",
        "updated"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}