@archastro/sdk
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • Retrieve a sample event payload Returns a representative sample payload for the specified workflow event type. Use this to inspect the structure of an event before configuring a workflow trigger or building an event handler. Requires a valid developer session. Returns 404 if the event name is not registered in the platform event catalog.

      Parameters

      • name: string

        Fully-qualified event type name registered in the catalog, e.g. "thread.created". Returns 404 if the name is not recognized.

      Returns Promise<{ sample: Record<string, unknown> }>

      Successful response