Payload schema
subscriptionKeystring
subscriptionType"configured" | "ephemeral"
subscriberobjectoptional
descriptionstringoptional
userobjectoptional
idstringoptional
emailstring
namestringoptional
picturestringoptional
processorobjectoptional
announcementobject
slugstring
versionstring
descriptionstring
consumesstring[]
emitsstring[]
ownedEventsobject[]
typestring
descriptionstringoptional
Raw JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"subscriptionKey": {
"type": "string",
"minLength": 1
},
"subscriptionType": {
"type": "string",
"enum": [
"configured",
"ephemeral"
]
},
"subscriber": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"picture": {
"type": "string",
"minLength": 1
}
},
"required": [
"email"
]
},
"processor": {
"type": "object",
"properties": {
"announcement": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1
},
"version": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
},
"consumes": {
"type": "array",
"items": {
"type": "string"
}
},
"emits": {
"type": "array",
"items": {
"type": "string"
}
},
"ownedEvents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
}
},
"required": [
"type"
]
}
}
},
"required": [
"slug",
"version",
"description",
"consumes",
"emits",
"ownedEvents"
]
}
},
"required": [
"announcement"
]
}
}
}
},
"required": [
"subscriptionKey",
"subscriptionType"
]
}