Payload schema
subscriptionKeystring
deliveryobject
mode: "wake"object
mode"wake"
expression(string | any[])[]
processorSlugstringoptional
mode: "push"object
mode"push"
expression(string | any[])[]
mode: "webhook"object
mode"webhook"
urlstring
descriptionstringoptional
selectorobjectoptional
eventTypesstring[]optional
conditionstringoptional
deliver"all" | "new" | objectoptional
afterOffsetinteger
onPoison"park" | "skip"optional
includeEphemeralbooleanoptional
paramsRecord<string, any>optional
Raw JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"subscriptionKey": {
"type": "string",
"minLength": 1
},
"delivery": {
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "wake"
},
"expression": {
"minItems": 1,
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
}
]
}
},
"processorSlug": {
"type": "string",
"minLength": 1
}
},
"required": [
"mode",
"expression"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "push"
},
"expression": {
"minItems": 1,
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
}
]
}
}
},
"required": [
"mode",
"expression"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "webhook"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"mode",
"url"
],
"additionalProperties": false
}
]
},
"description": {
"type": "string",
"minLength": 1
},
"selector": {
"type": "object",
"properties": {
"eventTypes": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"condition": {
"type": "string",
"minLength": 1
}
}
},
"deliver": {
"anyOf": [
{
"type": "string",
"const": "all"
},
{
"type": "string",
"const": "new"
},
{
"type": "object",
"properties": {
"afterOffset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"afterOffset"
],
"additionalProperties": false
}
]
},
"onPoison": {
"type": "string",
"enum": [
"park",
"skip"
]
},
"includeEphemeral": {
"type": "boolean"
},
"params": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"subscriptionKey",
"delivery"
]
}