endpoints.yaml

config/sites/<key>/endpoints.yaml declares the site’s endpoints: enquiry and contact forms, newsletter sign-up and other actions a page posts to. Each validates its inputs, runs its steps in order and responds with a fragment or a redirect.

endpoints:
  - key: contact
    path: /contact
    methods: [post]
    access: public
    rate_limit: 5/hour/ip
    input:
      email: { type: text, format: email, required: true, label: { en-GB: Your email address } }
      message: { type: text, multiline: true, max: 2000, label: { en-GB: Your message } }
    steps:
      - store: { as: enquiry, retention: 90d }
      - mail: { template: enquiry-receipt, to: $email }
    respond:
      fragment: partials/contact-sent.html
      on_error: partials/contact-form.html

engine-dmo dev endpoint add <key> --from recipe:enquiry (or recipe:newsletter) adds one from a recipe. Forms and submissions covers inputs, steps and responses in full.

The verb writes the endpoint and exits 0, but leaves its templates to you, so engine-dmo check fails until they exist: the respond fragments under partials/, and one email template for each mail step. A mail step’s template: enquiry-receipt is the file emails/enquiry-receipt.html in one of the site’s template roots, such as templates/_shared/emails/enquiry-receipt.html; the check’s message (which is not under templates/emails/) means the emails/ folder of any root.

Give each input’s label in every locale the site serves. check warns about a schema label missing a locale, but not about an endpoint input’s.