Skip to main content

REFERENCE

Developer Reference

Authentication, APIs, SDKs, Flow Agent processors and parameter resolution, in full.

asgard.message.start

asgard.message.start is the start of a message, telling the client that a new response is about to begin. It may already carry some initial text.

  1. Characteristics​

    • When it fires: as the AI begins generating a response
    • What it does: lets the frontend set up its display, possibly with initial text
    • How often: once per message response
  2. The fields that matter​

    FieldDescription
    messageStart.message.textMay carry initial text, or be an empty string while the delta events follow
    messageStart.message.idxUsually null; it has a value only in delta events
    messageStart.message.templateUsually null; it has a value only in the complete event
  3. Full example​

    {
    "eventType": "asgard.message.start",
    "requestId": "6939c5a6c590d90c401e3850a1ff44f3",
    "namespace": "qa-7e301310-a594-4a7b-aa2a-xxxxxxxxxxxx",
    "botProviderName": "bpapi-d97c512f-f8dc-46f6-82f0-xxxxxxxxxxxx",
    "customChannelId": "ch-6xxxxxxxxxxxx",
    "fact": {
    "runInit": null,
    "runDone": null,
    "runError": null,
    "messageStart": {
    "message": {
    "messageId": "1834828082242916352",
    "replyToCustomMessageId": "",
    "text": "", // ← may be empty or carry initial text
    "payload": {},
    "isDebug": false,
    "idx": null, // ← note: null at the start
    "template": {
    "type": "TEXT",
    "text": ""
    }
    }
    },
    "messageDelta": null, // ← the other events are null
    "messageComplete": null
    }
    }

Ready to get started?

Want to see how Asgard fits your team? Talk to us.

Contact us