Skip to main content

Embed Jotform forms in wagtail.

Project description

tests codecov black Total alerts

Wagtail Jotform

Embedable Jotform forms for Wagtail pages.

Wagtail Jotform works by providing a new EmbeddedFormPage page type with a form choice field. Values for this form field are populated from the Jotform API.

Installation

Install from pypi:

pip install wagtail-jotform

Configuration

You will need an API key from Jotform. Add the following variables to your settings:

WAGTAIL_JOTFORM = {
    "API_KEY": "somekey",
    "API_URL": "https://api.jotform.com",
    "LIMIT": 50,
}

LIMIT is the number of results in each result set for form list. Default is 50. Maximum is 1000.

If your Jotform account is in EU safe mode, your JOTFORM_API_URL should be https://eu-api.jotform.com.

Add the following to your INSTALLED_APPS in settings, and note that wagtail_jotform depends on routable_page:

INSTALLED_APPS = [
    ...
    "wagtail_jotform",
    "wagtail.contrib.routable_page",
]

Thank you page

Thank you pages work via Wagtail's RoutablePageMixin.

When a form is created, the Jotform thankurl is set with your created form's thank you page URL, e.g. https://mysite.com/formpage/thank-you. When the form is submitted, the user will be redirected accordingly and be show the 'thank you' data specified on on the form page added.

Overriding templates

Wagtail Jotform has two templates:

  • embedded_form_page.html
  • thank_you.html

You can override these templates in your project by adding them in the following location:

  • your_project_root/
    • templates/
      • wagtail_jotform/
        • embed_form_page.html
        • thank_you.html

Contributing

We welcome contributions to this project. Please follow the contributing instructions to get started.

Release process

To release a new version, the Release documentation should be followed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_jotform-2.4.1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wagtail_jotform-2.4.1-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file wagtail_jotform-2.4.1.tar.gz.

File metadata

  • Download URL: wagtail_jotform-2.4.1.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for wagtail_jotform-2.4.1.tar.gz
Algorithm Hash digest
SHA256 9f4ec1160456323720e76317c758a10045969e8ec9bed7c1c2782200b4042893
MD5 47516b2bd9a767cad59bfc00ff91b49c
BLAKE2b-256 15b976a48b73b86bed269a16bcd4a9ae586440641ed5a66d8bc3f65bab355446

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_jotform-2.4.1.tar.gz:

Publisher: release.yml on torchbox/wagtail-jotform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wagtail_jotform-2.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_jotform-2.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a6077970f10bc27a8962f286b4b60cad9513167fee7d283838a9898454a15750
MD5 cdcb0970dc7058daf1e8c757aa9b7367
BLAKE2b-256 2d6c5184933c502aaa8ad691073893675e7527a56dbe574cc23d77b67f3ba5c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_jotform-2.4.1-py3-none-any.whl:

Publisher: release.yml on torchbox/wagtail-jotform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page