Content Event Definition 0.1.0

Accepts one of the following messages:

• #0

  • application/json

  Message IDContentfulWebhookEvent

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.contentful.webhook"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  headers

  Expand all

  required

  object

  The headers of the webhook event

  Additional properties:

  string

  body

  required

  string

  The body of the webhook event

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.contentful.webhook",
    "correlationid": "string",
    "data": {
      "headers": {
        "property1": "string",
        "property2": "string"
      },
      "body": "string"
    }
  }
  

  This example has been generated automatically.

• #1

  • application/json

  Message IDSiteCreated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.site.created"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"site"

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.site.created",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "site"
    }
  }
  

  This example has been generated automatically.

• #2

  • application/json

  Message IDSiteUpdated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.site.updated"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"site"

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.site.updated",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "site"
    }
  }
  

  This example has been generated automatically.

• #3

  • application/json

  Message IDSiteDeleted

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.site.deleted"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"site"

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.site.deleted",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "site"
    }
  }
  

  This example has been generated automatically.

• #4

  • application/json

  Message IDPageCreated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.page.created"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Allowed values:
  • "blog-news-page"
  • "brand-page"
  • "category-page"
  • "collection-page"
  • "content-page"
  • "health-fund-page"
  • "health-page"
  • "home-page"
  • "offer-page"
  • "service-page"
  • "faq-hub"
  • "faq-topic"
  • "faq-sub-topic"
  • "faq-details"

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.page.created",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "blog-news-page"
    }
  }
  

  This example has been generated automatically.

• #5

  • application/json

  Message IDPageUpdated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.page.updated"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Allowed values:
  • "blog-news-page"
  • "brand-page"
  • "category-page"
  • "collection-page"
  • "content-page"
  • "health-fund-page"
  • "health-page"
  • "home-page"
  • "offer-page"
  • "service-page"
  • "faq-hub"
  • "faq-topic"
  • "faq-sub-topic"
  • "faq-details"

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.page.updated",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "blog-news-page"
    }
  }
  

  This example has been generated automatically.

• #6

  • application/json

  Message IDPageDeleted

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.page.deleted"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Allowed values:
  • "blog-news-page"
  • "brand-page"
  • "category-page"
  • "collection-page"
  • "content-page"
  • "health-fund-page"
  • "health-page"
  • "home-page"
  • "offer-page"
  • "service-page"
  • "faq-hub"
  • "faq-topic"
  • "faq-sub-topic"
  • "faq-details"

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.page.deleted",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "blog-news-page"
    }
  }
  

  This example has been generated automatically.

• #7

  • application/json

  Message IDPageTemplateCreated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.page-template.created"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Allowed values:
  • "product-page-template"

  siteKeys

  Expand all

  required

  array<string>

  Items:

  string

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.page-template.created",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product-page-template",
      "siteKeys": [
        "string"
      ]
    }
  }
  

  This example has been generated automatically.

• #8

  • application/json

  Message IDPageTemplateUpdated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.page-template.updated"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Allowed values:
  • "product-page-template"

  siteKeys

  Expand all

  required

  array<string>

  Items:

  string

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.page-template.updated",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product-page-template",
      "siteKeys": [
        "string"
      ]
    }
  }
  

  This example has been generated automatically.

• #9

  • application/json

  Message IDPageTemplateDeleted

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new content events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/content-service"

  type

  required

  string

  Const:"com.specsavers.rtp.content.page-template.deleted"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Allowed values:
  • "product-page-template"

  siteKeys

  Expand all

  required

  array<string>

  Items:

  string

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/content-service",
    "type": "com.specsavers.rtp.content.page-template.deleted",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product-page-template",
      "siteKeys": [
        "string"
      ]
    }
  }
  

  This example has been generated automatically.