Type Alias Subscription<T>

Subscription: {
    agent: AgentId;
    args: T;
    channels: DeliveryChannel[];
    ephemeral?: boolean;
    id: SubscriptionId;
    public?: boolean;
}

Represents a persistent subscription.

Type Parameters

Type declaration

  • agent: AgentId

    The agent id.

  • args: T

    The specific agent inputs.

  • channels: DeliveryChannel[]

    An array of delivery channels.

  • Optionalephemeral?: boolean

    Indicates the persistence preference.

  • id: SubscriptionId

    The subscription id. Must be unique.

  • Optionalpublic?: boolean

    Indicates a public scope.

Example

{
  id: "polkadot-transfers",
  agent: "xcm",
  args: {
    origin: "0",
    senders: "*",
    destinations: [
      "2000",
      "1000"
    ],
    events: "*",
  },
  channels: [
    {
      type: "webhook",
      url: "https://some.webhook"
    },
    {
      type: "websocket"
    }
  ]
}

Settings

Member Visibility