Forms

Get embed code

GET/v1/forms/{formId}/embed

Get the snippets that put a form on a website, and the draft's display settings that say which one to use. Display settings go live when the form is published.

curl "$AYEFORM_API/v1/forms/$FORM_ID/embed" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "script": "…",
  "button": "…",
  "inline": "…",
  "embed": "…",
  "widget": "…",
  "jsOpen": "…",
  "events": "…",
  "view": "popup",
  "side": "right",
  "onPage": "button",
  "buttonLabel": "…"
}

Path parameters

formIdstringrequired
The form's id.

Response

scriptstringrequired
The loader script. Add it once per page.
buttonstringrequired
A button that opens the form.
inlinestringrequired
An inline field that starts the form.
embedstringrequired
The whole form in the page, in the element's place.
widgetstringrequired
The corner widget.
jsOpenstringrequired
The JS API call that opens the form, with prefill.
eventsstringrequired
An event listener that runs when the form is submitted.
viewenumrequired
How the form opens: as a popup, in the corner widget, or full screen. embed doesn't use it.
One of "popup", "widget", "fullscreen"
sideenumrequired
The corner the widget docks to.
One of "right", "left"
onPageenumrequired
Which of the snippets above to use. It comes from the draft's settings.display.
One of "button", "inline", "embed", "widget"
buttonLabelstringrequired
The text on the button.

Errors answer with a status and the error shape.