Skip to content

SubscriptionCompatCreateInput

SubscriptionCompatCreateInput

Input shape for client.subscription.create, discriminated on eventType (GH-4679, GH-6553):

  • default / commit — operation-based, repo-scoped (repoName); requires a filterJson object and a shape binding (shapeName or filterJson.shape).
  • repo.renamed / thing.renamed / shape.renamed — repo-scoped metadata events; no shape/filter/source.
  • org-scoped metadata events — no repoName/shape/filter/source.

The metadata variants forbid the commit-only fields at the type level so invalid shapes fail at compile time, not just server-side.

https://docs.warmhub.ai/subscriptions/creating/