events.iterate.com

Event type

events.iterate.com/stream/subscription-configured

Configures or replaces one durable subscription for sending this stream's events to a receiver. This is the sole event that enables delivery.

Payload schema

namestringoptional
descriptionstringoptional
filterobjectoptional
eventTypesstring[]optional
jsonataConditionstringoptional
receiverobject
action: "facet-processor"object
action"facet-processor"
sourceobject
kind: "builtin"object
kind"builtin"
kind: "userspace"object
kind"userspace"
workerobject
action: "wake-processor"object
action"wake-processor"
expression(string | any[])[]
action: "copy-to-stream"object
action"copy-to-stream"
receivingStreamPathstring
jsonataTransformstringoptional
deliveryobject
start"beginning" | "now"
onFailingEvent"halt"
action: "itx-call"object
action"itx-call"
expression(string | any[])[]
jsonataTransformstringoptional
deliveryobject
start"beginning" | "now"
onFailingEvent"halt" | "skip"
action: "webhook-post"object
action"webhook-post"
urlstring
jsonataTransformstringoptional
deliveryobject
start"beginning" | "now"
onFailingEvent"halt" | "skip"
Raw JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "description": {
      "type": "string",
      "minLength": 1
    },
    "filter": {
      "type": "object",
      "properties": {
        "eventTypes": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "jsonataCondition": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "receiver": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "facet-processor"
            },
            "source": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "const": "builtin"
                    }
                  },
                  "required": [
                    "kind"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "const": "userspace"
                    },
                    "worker": {
                      "type": "object",
                      "properties": {
                        "path": {
                          "type": "string"
                        },
                        "source": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {
                                "createApp": {
                                  "type": "object",
                                  "properties": {
                                    "bundle": {
                                      "type": "boolean"
                                    },
                                    "conditions": {
                                      "type": "array",
                                      "items": {
                                        "type": "string"
                                      }
                                    },
                                    "define": {
                                      "type": "object",
                                      "propertyNames": {
                                        "type": "string"
                                      },
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    },
                                    "externals": {
                                      "type": "array",
                                      "items": {
                                        "type": "string"
                                      }
                                    },
                                    "jsx": {
                                      "type": "string",
                                      "enum": [
                                        "transform",
                                        "preserve",
                                        "automatic"
                                      ]
                                    },
                                    "jsxImportSource": {
                                      "type": "string"
                                    },
                                    "loader": {
                                      "type": "object",
                                      "propertyNames": {
                                        "type": "string"
                                      },
                                      "additionalProperties": {
                                        "type": "string",
                                        "enum": [
                                          "js",
                                          "jsx",
                                          "ts",
                                          "tsx",
                                          "json",
                                          "css",
                                          "text",
                                          "binary",
                                          "base64",
                                          "dataurl"
                                        ]
                                      }
                                    },
                                    "minify": {
                                      "type": "boolean"
                                    },
                                    "registry": {
                                      "type": "string"
                                    },
                                    "sourcemap": {
                                      "type": "boolean"
                                    },
                                    "target": {
                                      "type": "string"
                                    },
                                    "assetConfig": {
                                      "type": "object",
                                      "properties": {
                                        "headers": {
                                          "type": "object",
                                          "propertyNames": {
                                            "type": "string"
                                          },
                                          "additionalProperties": {
                                            "type": "object",
                                            "properties": {
                                              "set": {
                                                "type": "object",
                                                "propertyNames": {
                                                  "type": "string"
                                                },
                                                "additionalProperties": {
                                                  "type": "string"
                                                }
                                              },
                                              "unset": {
                                                "type": "array",
                                                "items": {
                                                  "type": "string"
                                                }
                                              }
                                            },
                                            "additionalProperties": false
                                          }
                                        },
                                        "html_handling": {
                                          "type": "string",
                                          "enum": [
                                            "auto-trailing-slash",
                                            "force-trailing-slash",
                                            "drop-trailing-slash",
                                            "none"
                                          ]
                                        },
                                        "not_found_handling": {
                                          "type": "string",
                                          "enum": [
                                            "single-page-application",
                                            "404-page",
                                            "none"
                                          ]
                                        },
                                        "redirects": {
                                          "type": "object",
                                          "properties": {
                                            "dynamic": {
                                              "type": "object",
                                              "propertyNames": {
                                                "type": "string"
                                              },
                                              "additionalProperties": {
                                                "type": "object",
                                                "properties": {
                                                  "status": {
                                                    "type": "number"
                                                  },
                                                  "to": {
                                                    "type": "string"
                                                  }
                                                },
                                                "required": [
                                                  "status",
                                                  "to"
                                                ],
                                                "additionalProperties": false
                                              }
                                            },
                                            "static": {
                                              "type": "object",
                                              "propertyNames": {
                                                "type": "string"
                                              },
                                              "additionalProperties": {
                                                "type": "object",
                                                "properties": {
                                                  "status": {
                                                    "type": "number"
                                                  },
                                                  "to": {
                                                    "type": "string"
                                                  }
                                                },
                                                "required": [
                                                  "status",
                                                  "to"
                                                ],
                                                "additionalProperties": false
                                              }
                                            }
                                          },
                                          "additionalProperties": false
                                        }
                                      },
                                      "additionalProperties": false
                                    },
                                    "assets": {
                                      "type": "object",
                                      "propertyNames": {
                                        "type": "string"
                                      },
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    },
                                    "client": {
                                      "anyOf": [
                                        {
                                          "type": "string"
                                        },
                                        {
                                          "type": "array",
                                          "items": {
                                            "type": "string"
                                          }
                                        }
                                      ]
                                    },
                                    "files": {
                                      "oneOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "files": {
                                              "type": "object",
                                              "propertyNames": {
                                                "type": "string"
                                              },
                                              "additionalProperties": {
                                                "type": "string"
                                              }
                                            },
                                            "type": {
                                              "type": "string",
                                              "const": "inline"
                                            }
                                          },
                                          "required": [
                                            "files",
                                            "type"
                                          ],
                                          "additionalProperties": false
                                        },
                                        {
                                          "type": "object",
                                          "properties": {
                                            "exclude": {
                                              "type": "array",
                                              "items": {
                                                "type": "string"
                                              }
                                            },
                                            "include": {
                                              "type": "array",
                                              "items": {
                                                "type": "string"
                                              }
                                            },
                                            "ref": {
                                              "anyOf": [
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "branch": {
                                                      "type": "string",
                                                      "minLength": 1
                                                    }
                                                  },
                                                  "required": [
                                                    "branch"
                                                  ],
                                                  "additionalProperties": false
                                                },
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "branch": {
                                                      "type": "string",
                                                      "minLength": 1
                                                    },
                                                    "commitOid": {
                                                      "type": "string",
                                                      "pattern": "^[0-9a-f]{40}$"
                                                    }
                                                  },
                                                  "required": [
                                                    "commitOid"
                                                  ],
                                                  "additionalProperties": false
                                                }
                                              ]
                                            },
                                            "repoPath": {
                                              "type": "string"
                                            },
                                            "type": {
                                              "type": "string",
                                              "const": "repo"
                                            }
                                          },
                                          "required": [
                                            "repoPath",
                                            "type"
                                          ],
                                          "additionalProperties": false
                                        }
                                      ]
                                    },
                                    "server": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "files"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              "required": [
                                "createApp"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "object",
                              "properties": {
                                "createWorker": {
                                  "type": "object",
                                  "properties": {
                                    "bundle": {
                                      "type": "boolean"
                                    },
                                    "conditions": {
                                      "type": "array",
                                      "items": {
                                        "type": "string"
                                      }
                                    },
                                    "define": {
                                      "type": "object",
                                      "propertyNames": {
                                        "type": "string"
                                      },
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    },
                                    "externals": {
                                      "type": "array",
                                      "items": {
                                        "type": "string"
                                      }
                                    },
                                    "jsx": {
                                      "type": "string",
                                      "enum": [
                                        "transform",
                                        "preserve",
                                        "automatic"
                                      ]
                                    },
                                    "jsxImportSource": {
                                      "type": "string"
                                    },
                                    "loader": {
                                      "type": "object",
                                      "propertyNames": {
                                        "type": "string"
                                      },
                                      "additionalProperties": {
                                        "type": "string",
                                        "enum": [
                                          "js",
                                          "jsx",
                                          "ts",
                                          "tsx",
                                          "json",
                                          "css",
                                          "text",
                                          "binary",
                                          "base64",
                                          "dataurl"
                                        ]
                                      }
                                    },
                                    "minify": {
                                      "type": "boolean"
                                    },
                                    "registry": {
                                      "type": "string"
                                    },
                                    "sourcemap": {
                                      "type": "boolean"
                                    },
                                    "target": {
                                      "type": "string"
                                    },
                                    "entryPoint": {
                                      "type": "string"
                                    },
                                    "files": {
                                      "oneOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "files": {
                                              "type": "object",
                                              "propertyNames": {
                                                "type": "string"
                                              },
                                              "additionalProperties": {
                                                "type": "string"
                                              }
                                            },
                                            "type": {
                                              "type": "string",
                                              "const": "inline"
                                            }
                                          },
                                          "required": [
                                            "files",
                                            "type"
                                          ],
                                          "additionalProperties": false
                                        },
                                        {
                                          "type": "object",
                                          "properties": {
                                            "exclude": {
                                              "type": "array",
                                              "items": {
                                                "type": "string"
                                              }
                                            },
                                            "include": {
                                              "type": "array",
                                              "items": {
                                                "type": "string"
                                              }
                                            },
                                            "ref": {
                                              "anyOf": [
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "branch": {
                                                      "type": "string",
                                                      "minLength": 1
                                                    }
                                                  },
                                                  "required": [
                                                    "branch"
                                                  ],
                                                  "additionalProperties": false
                                                },
                                                {
                                                  "type": "object",
                                                  "properties": {
                                                    "branch": {
                                                      "type": "string",
                                                      "minLength": 1
                                                    },
                                                    "commitOid": {
                                                      "type": "string",
                                                      "pattern": "^[0-9a-f]{40}$"
                                                    }
                                                  },
                                                  "required": [
                                                    "commitOid"
                                                  ],
                                                  "additionalProperties": false
                                                }
                                              ]
                                            },
                                            "repoPath": {
                                              "type": "string"
                                            },
                                            "type": {
                                              "type": "string",
                                              "const": "repo"
                                            }
                                          },
                                          "required": [
                                            "repoPath",
                                            "type"
                                          ],
                                          "additionalProperties": false
                                        }
                                      ]
                                    },
                                    "virtualModules": {
                                      "type": "object",
                                      "propertyNames": {
                                        "type": "string"
                                      },
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    }
                                  },
                                  "required": [
                                    "files"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              "required": [
                                "createWorker"
                              ],
                              "additionalProperties": false
                            }
                          ]
                        },
                        "className": {
                          "type": "string"
                        },
                        "durableWorkerKey": {
                          "type": "string",
                          "pattern": "^[a-z][a-z0-9-]{0,62}$"
                        },
                        "type": {
                          "type": "string",
                          "const": "stateful"
                        }
                      },
                      "required": [
                        "path",
                        "source",
                        "className",
                        "durableWorkerKey",
                        "type"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "kind",
                    "worker"
                  ],
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "action",
            "source"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "wake-processor"
            },
            "expression": {
              "minItems": 1,
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {}
                  }
                ]
              }
            }
          },
          "required": [
            "action",
            "expression"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "copy-to-stream"
            },
            "receivingStreamPath": {
              "type": "string",
              "minLength": 1
            },
            "jsonataTransform": {
              "type": "string",
              "minLength": 1
            },
            "delivery": {
              "type": "object",
              "properties": {
                "start": {
                  "type": "string",
                  "enum": [
                    "beginning",
                    "now"
                  ]
                },
                "onFailingEvent": {
                  "type": "string",
                  "const": "halt"
                }
              },
              "required": [
                "start",
                "onFailingEvent"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "action",
            "receivingStreamPath",
            "delivery"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "itx-call"
            },
            "expression": {
              "minItems": 1,
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {}
                  }
                ]
              }
            },
            "jsonataTransform": {
              "type": "string",
              "minLength": 1
            },
            "delivery": {
              "type": "object",
              "properties": {
                "start": {
                  "type": "string",
                  "enum": [
                    "beginning",
                    "now"
                  ]
                },
                "onFailingEvent": {
                  "type": "string",
                  "enum": [
                    "halt",
                    "skip"
                  ]
                }
              },
              "required": [
                "start",
                "onFailingEvent"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "action",
            "expression",
            "delivery"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "const": "webhook-post"
            },
            "url": {
              "type": "string",
              "format": "uri"
            },
            "jsonataTransform": {
              "type": "string",
              "minLength": 1
            },
            "delivery": {
              "type": "object",
              "properties": {
                "start": {
                  "type": "string",
                  "enum": [
                    "beginning",
                    "now"
                  ]
                },
                "onFailingEvent": {
                  "type": "string",
                  "enum": [
                    "halt",
                    "skip"
                  ]
                }
              },
              "required": [
                "start",
                "onFailingEvent"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "action",
            "url",
            "delivery"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "receiver"
  ],
  "additionalProperties": false
}