It is used to specify the url from which the form definition is retrieved. Only required if data-id is not used, or if presenting an advocacy related form, which requires getting the form definition from a different endpoint. Example, to load a form from a url:
<div class="ngp-form" data-form-url="https://actions.everyaction.com/v1/Forms/5r7I2eqN-kyshSYk6ZS6Rg2"></div>
For advocacy related forms, you have to request the form definition through our advocacy service, which we creatively call advocator. This URL is constructed using the following pattern:
- Advocacy form proxy url, e.g. https://advocator.ngpvan.com
- The URL encoded database API endpoint, meaning take the endpoint
https://actions.everyaction.com/v1/Forms/
and represent it like this:https%3A%2F%2Factions.everyaction.com%2Fv1%2FForms%2F
- the form ID, e.g.
ntieGYzrK0meNMqRibRbAw2
- and finally the string
ngpForm
at the end
Complete example for an advocacy related form, where we grab the form definition from the advocacy endpoint, with the rest of the form ID URL encoded after:
<div class="ngp-form" data-form-url="https://advocator.ngpvan.com/https%3a%2f%2fsecure.everyaction.com%2fv1%2fForms%2fntieGYzrK0meNMqRibRbAw2/ngpForm"></div>