Interface: WebhookEvent

What a module read from a webhook.

Properties

error?

optional error?: string;

---

eventId

eventId: string;

The vendor's event id, for de-duplication, read where the signature covers it; without one, webhookEventId(ctx, externalId, request.body).

---

externalId

externalId: string;

The vendor's identifier the asynchronous action returned, read from what the signature covers. The API refuses an event naming another session than the one it found the request for (401), by ?externalId= or the source the manifest or the install names.

---

output?

optional output?: unknown;

Validated by the host against the action's output schema when status is completed.

---

status

status: "completed" | "failed" | "pending";