Buttondown logo

Export statuses

---
config:
  layout: elk
  elk:
    mergeEdges: true
    nodePlacementStrategy: LINEAR_SEGMENTS
---

flowchart-elk
    api([api.buttondown.com/v1/exports]) --> not_started[Not started]
    not_started e1@--> in_progress[In progress]
    not_started e7@--> export_created>export.created]
    in_progress e2@--> ready[Ready]
    ready e3@--> s3>buttondown.com/exports/1234567890.zip]
    ready e5@--> export_completed>export.completed]
    in_progress e4@--> error[Error]
    error e6@--> export_failed>export.failed]
    e1@{ animate: true }
    e2@{ animate: true }
    e3@{ animate: true }
    e4@{ animate: true }
    e5@{ animate: true }
    e6@{ animate: true }
    e7@{ animate: true }
    click export_failed href "event-types#export.failed"
    click export_completed href "event-types#export.completed"
    click export_created href "event-types#export.created"

    Represents the status of an export.

    No action is required to move from one state or another; Buttondown
    internally handles the transitions, and exposing the status is for
    observability purposes only.

Error

Type
error
Description

The export was unable to be completed. Buttondown is looking into it.

In progress

Type
in_progress
Description

The export is currently being processed.

Not started

Type
not_started
Description

The export has not yet started.

Ready

Type
ready
Description

The export has completed.