Amazon Pinpoint · JSON Structure

Amazon Pinpoint Campaign Event Filter Structure

Specifies the settings for events that cause a campaign to be sent.

Type: object Properties: 2 Required: 2
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

CampaignEventFilter is a JSON Structure definition published by Amazon Pinpoint, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Dimensions FilterType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-campaign-event-filter-structure.json",
  "name": "CampaignEventFilter",
  "description": "Specifies the settings for events that cause a campaign to be sent.",
  "type": "object",
  "properties": {
    "Dimensions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventDimensions"
        },
        {
          "description": "The dimension settings of the event filter for the campaign."
        }
      ]
    },
    "FilterType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterType"
        },
        {
          "description": "The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (<link  linkend=\"apps-application-id-events\">Events</link> resource) occurs."
        }
      ]
    }
  },
  "required": [
    "FilterType",
    "Dimensions"
  ]
}