science.astro-colibri.alert.ac

astro-colibri.science

Documentation

Astro-COLIBRI alert with the full event in Astro-COLIBRI's native JSON format. See https://astro-colibri.science/apidoc#voevent_section for the payload parameters.

main record

Astro-COLIBRI alert with the full event in Astro-COLIBRI's native JSON format. See https://astro-colibri.science/apidoc#voevent_section for the payload parameters.

Record Key tid Timestamp-based ID

Properties

alertType string Required

Event or source type used by Astro-COLIBRI. Includes transient classes, catalogue source classes, and tilepy observation tiles. Known values retain the spelling used by the filters and listeners; additional values are allowed.

maxLength: 128 bytes
Known values: burst, frb, grb, grb_optical, gw, gw_optical, neutrino, nuem, ot, ot_other, ot_sn, star
astroColibriID string Required

Unique event identifier assigned by Astro-COLIBRI. It identifies the same event across revisions and payload formats.

maxLength: 128 bytes
broker string Required

Broker, classifier, or service that submitted the event. Known values come from the general filter, plus GCN and TNS as emitted by the listeners. An empty string means unspecified; additional brokers are allowed.

maxLength: 128 bytes
Known values: FLAAPLUC, CBAT, FINK, ampel, unistellar, bhtom, last, GCN, TNS
createdAt string datetime Required

Timestamp when this AT Protocol alert record was created, including a timezone (prefer UTC with a Z suffix). This is distinct from the event detection time in data.

data object Required

Full event object in Astro-COLIBRI's native JSON format, as returned by /get_event. The payload is intentionally open to preserve event-specific fields; see https://astro-colibri.science/apidoc#voevent_section.

important boolean Optional

Whether this alert qualifies for the Astro-COLIBRI important stream. This is separate from the VOEvent Why.importance value.

instrument string Optional

Instrument or analysis that detected or localized the event, when known. Additional instruments are allowed.

maxLength: 128 bytes
Known values: BAT, BAT-GUANO, ECLAIRs, FXT, GBM, GBM-BALROG, GRM, GSC, LAT, LAT-FLaapLUC, LEIA, MXT, UVOT, VT, WXT, XRT
observatory string Required

Discovery observatory, experiment, or source catalogue. Known values include filter labels and spellings emitted by the listeners; additional observatories are allowed.

maxLength: 128 bytes
Known values: AMON, ASKAP, ATCA, ATLAS, CHIME, CHIMEFRB, CRAFT, Einstein Probe, FAST, GECAM, HAWC, IPN, Integral, LAST, LOFAR, LSST, MASTER, MAXI, MWA, MeerKAT, Pan-STARRS, Parkes, Rubin, UTMOST, VLA, ZTF
triggerID string Required

Trigger identifier used by Astro-COLIBRI for the event, matching data.trigger_id in the native JSON payload.

maxLength: 128 bytes
View raw schema
{
  "description": "Astro-COLIBRI alert with the full event in Astro-COLIBRI's native JSON format. See https://astro-colibri.science/apidoc#voevent_section for the payload parameters.",
  "key": "tid",
  "record": {
    "properties": {
      "alertType": {
        "description": "Event or source type used by Astro-COLIBRI. Includes transient classes, catalogue source classes, and tilepy observation tiles. Known values retain the spelling used by the filters and listeners; additional values are allowed.",
        "knownValues": [
          "burst",
          "frb",
          "grb",
          "grb_optical",
          "gw",
          "gw_optical",
          "neutrino",
          "nuem",
          "ot",
          "ot_other",
          "ot_sn",
          "star"
        ],
        "maxLength": 128,
        "type": "string"
      },
      "astroColibriID": {
        "description": "Unique event identifier assigned by Astro-COLIBRI. It identifies the same event across revisions and payload formats.",
        "maxLength": 128,
        "type": "string"
      },
      "broker": {
        "description": "Broker, classifier, or service that submitted the event. Known values come from the general filter, plus GCN and TNS as emitted by the listeners. An empty string means unspecified; additional brokers are allowed.",
        "knownValues": [
          "FLAAPLUC",
          "CBAT",
          "FINK",
          "ampel",
          "unistellar",
          "bhtom",
          "last",
          "GCN",
          "TNS"
        ],
        "maxLength": 128,
        "type": "string"
      },
      "createdAt": {
        "description": "Timestamp when this AT Protocol alert record was created, including a timezone (prefer UTC with a Z suffix). This is distinct from the event detection time in data.",
        "format": "datetime",
        "type": "string"
      },
      "data": {
        "description": "Full event object in Astro-COLIBRI's native JSON format, as returned by /get_event. The payload is intentionally open to preserve event-specific fields; see https://astro-colibri.science/apidoc#voevent_section.",
        "properties": {},
        "type": "object"
      },
      "important": {
        "description": "Whether this alert qualifies for the Astro-COLIBRI important stream. This is separate from the VOEvent Why.importance value.",
        "type": "boolean"
      },
      "instrument": {
        "description": "Instrument or analysis that detected or localized the event, when known. Additional instruments are allowed.",
        "knownValues": [
          "BAT",
          "BAT-GUANO",
          "ECLAIRs",
          "FXT",
          "GBM",
          "GBM-BALROG",
          "GRM",
          "GSC",
          "LAT",
          "LAT-FLaapLUC",
          "LEIA",
          "MXT",
          "UVOT",
          "VT",
          "WXT",
          "XRT"
        ],
        "maxLength": 128,
        "type": "string"
      },
      "observatory": {
        "description": "Discovery observatory, experiment, or source catalogue. Known values include filter labels and spellings emitted by the listeners; additional observatories are allowed.",
        "knownValues": [
          "AMON",
          "ASKAP",
          "ATCA",
          "ATLAS",
          "CHIME",
          "CHIMEFRB",
          "CRAFT",
          "Einstein Probe",
          "FAST",
          "GECAM",
          "HAWC",
          "IPN",
          "Integral",
          "LAST",
          "LOFAR",
          "LSST",
          "MASTER",
          "MAXI",
          "MWA",
          "MeerKAT",
          "Pan-STARRS",
          "Parkes",
          "Rubin",
          "UTMOST",
          "VLA",
          "ZTF"
        ],
        "maxLength": 128,
        "type": "string"
      },
      "triggerID": {
        "description": "Trigger identifier used by Astro-COLIBRI for the event, matching data.trigger_id in the native JSON payload.",
        "maxLength": 128,
        "type": "string"
      }
    },
    "required": [
      "alertType",
      "observatory",
      "broker",
      "triggerID",
      "astroColibriID",
      "data",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@