Skip to main content

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.

Metadata

Release files for wagtail-jotform 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wagtail-jotform 2.2.0
File Size Uploaded
wagtail-jotform-2.2.0.tar.gz 10.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wagtail-jotform 2.2.0
File Interpreter ABI Platform
wagtail_jotform-2.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 21.1 kB

Release files / wagtail-jotform-2.2.0.tar.gz

Download URL wagtail-jotform-2.2.0.tar.gz
Size 10.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4662da302b9f427c0ec5774ad9cf9e59c81d0d201755daeb49a691775851a62a
BLAKE2b-256 checksum
How to use checksums
ef05ec7e4bda4b5b0baac1e8ff431189e6577284965f6bbcb228a4ad7b027e8d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.18

Release files / wagtail_jotform-2.2.0-py3-none-any.whl

Download URL wagtail_jotform-2.2.0-py3-none-any.whl
Size 11.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1d211790ffd0612af49e91236a8dcfb79f4afca440d65fe75c7f87391803497f
BLAKE2b-256 checksum
How to use checksums
485e264d3bc0316494f3e94f21638970d9bf4bf591875c66c4f391a636aa7ee1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.18

Release history Release notifications | RSS feed

2.4.1

2 release files

2.3.0

2 release files

This release

2.2.0 This release

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.0.6

2 release files

1.0.4

1 release file

1.0.3

2 release files

1.0.2

2 release files

1.0.1

1 release file

1.0.0

1 release file

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page