TriggerEvent

import type { TriggerEvent } from "@elie-laloum/outpost";

Paramètres et propriétés

sourceRequis
string
Nom de la source, comme github, gitlab, slack ou standard.
deliveryRequis
string
Identifiant de livraison de l’émetteur, partagé par les nouvelles tentatives d’une livraison ; de 1 à 200 caractères ASCII visibles.
kindRequis
string
Type d’événement : nom d’événement GitHub, object_kind GitLab, command ou type d’interaction Slack, ou type de charge Standard Webhooks.
actionOptionnel
string | undefined
Sous-action lorsque l’émetteur en fournit une, comme labeled, update ou le nom de la commande Slack.
actorOptionnel
string | undefined
Identité authentifiée par l’émetteur, comme github:octocat, gitlab:user ou slack:U123 ; pas un acteur de gate Outpost.
payloadRequis
WorkflowJson
Corps analysé : le document JSON, les champs du formulaire d’une commande slash Slack ou la charge JSON d’une interaction Slack. Affinez son type avant usage, ou lisez-le avec labelAdded() et commandIssued().
receivedAtRequis
string
Heure ISO à laquelle le serveur a vérifié la requête.

Signature

export interface TriggerEvent {
  readonly source: string;
  /** Sender delivery identifier; retries of one delivery share it. */
  readonly delivery: string;
  readonly kind: string;
  readonly action?: string;
  /** Sender-authenticated identity such as `github:octocat`; not an Outpost actor. */
  readonly actor?: string;
  readonly payload: WorkflowJson;
  readonly receivedAt: string;
}

Contrats associés

WorkflowJson