Event Reference

Event envelopes, active event types, catalog schemas, and delivery semantics.

Alfred emits versioned domain events from a transactional outbox. Use exact event type strings, including the version suffix.

Event Envelope

FieldMeaning
eventIdStable event identifier for deduplication and SSE replay.
eventTypeVersioned type such as CertificateIssued.v2.
eventVersionVersion suffix such as v2.
executionIdOwning Alfred execution.
principalIdOwning principal.
occurredAtISO 8601 event time.
payloadJsonEvent-specific payload validated by its Zod schema.
traceparentOptional W3C trace context.

Current Catalog

Event typePurpose
LambdaVersionRestoreCompleted.v1Lambda version restoration reached its terminal result.
LambdaVersionUpdateCompleted.v1Lambda version update reached its terminal result.
BulkOperationProgress.v1Reports child progress for a bulk operation.
BulkOperationCompleted.v1Reports aggregate bulk completion.
DomainRegistered.v1Domain registration completed.
OnboardingCompleted.v2Current onboarding completion contract.
CertificateRequested.v1Certificate workflow accepted.
CertificateStageCompleted.v1A certificate stage completed.
CertificateValidated.v1ACM validation completed.
DistributionCreated.v1CloudFront distribution created.
DistributionUpdated.v1CloudFront distribution updated.
DistributionDeployed.v1CloudFront deployment completed.
CertificateIssued.v2Current certificate completion contract.
CertificateFailed.v1Certificate workflow failed.
CertificateRollbackCompleted.v1Compensation completed.
CertificateRollbackFailed.v1Compensation failed.
CertificateCompensationRequested.v1Compensation was requested.
WorkflowStageTimedOut.v1A stage exceeded its time policy.

OnboardingCompleted.v1 and CertificateIssued.v1 remain cataloged as deprecated versions. New integrations should consume the active v2 contracts.

Schema Discovery

Fetch the runtime catalog:

curl --fail-with-body --silent --show-error \
  "$ALFRED_API_URL/v1/events/catalog" | jq

Each entry includes lifecycle metadata and a JSON Schema generated from the event's Zod payload schema.

Delivery Guarantees

  • Event IDs are stable and should be deduplicated by consumers.
  • Execution readback is the reconciliation source for one workflow.
  • SSE is live delivery with replay from Last-Event-ID when retained.
  • Webhooks are retried with bounded backoff and expose delivery history.
  • Event versions are independent contracts; do not deserialize multiple versions into one unchecked shape.

Execution Reference

Execution fields, statuses, stage records, filters, and control routes.

API Reference

Generated OpenAPI operations and schemas for the Alfred API.

Event Envelope
Current Catalog
Schema Discovery
Delivery Guarantees