--- title: "Lumin Integration" slug: "lumin-integration" description: "Set up the Lumin integration to map form data to Lumin Sign templates and automatically request signatures from recipients after submission." updated: 2026-10-26T15:11:06Z published: 2026-10-26T15:11:06Z canonical: "www.civicplus.help/lumin-integration" --- > ## Documentation Index > Fetch the complete documentation index at: https://www.civicplus.help/llms.txt > Use this file to discover all available pages before exploring further. # Lumin Integration The Lumin integration allows you to map form data to Lumin Sign templates and automatically request signatures from one or more recipients after a form is submitted. This can be used to send agreements, consent forms, or authorizations for signing without anyone needing to prepare or send the document manually. Signers can sign in parallel or in a set order, based on how the template is configured in Lumin. > [!NOTE] > Important Note > > You will need to have a Lumin account to use this integration. ## Create a Lumin Sign Template Before setting up the workflow event, you will need a signing template in Lumin Sign. The template holds the PDF, the signer roles, the signing order, and the fields each signer needs to complete. 1. Open Lumin Sign and go to **My templates**, **Create template**. 2. Upload the PDF you want to use. 3. Select **Add signer roles**. Define roles such as Applicant and Approver, rather than particular people. ![Electronic signature interface highlights the Add signer button beneath recipient fields and signing options.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Add%20Signer%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 4. Configure the signing order. Choose simultaneous signing or an ordered sequence. 5. Place the signing fields on the PDF and assign them to the appropriate roles. For example, assign the applicant's signature field to Applicant. ![Pet registration application highlights required signatures for pet owner and council officer.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Add%20Signers%20to%20Form%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 6. Select **Save template**. This saves the reusable configuration; it does not send a request to anyone. --- ## Set Up the Integration 1. [Sign in to your site](/process-automation/docs/sign-in-to-your-site) 2. Navigate to the **Workspace menu** and click **Settings** ![Navigation menu showing 'My Workspace' and 'Settings' options.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Environments, Settings - PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 3. Select **Integrations** ![](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Integrations Menu - PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 4. Select the **Setup Integration** button on the **Lumin** card ![Lumin integration card highlights setup integration for mapping form data to PDF templates and requesting signatures.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Setup%20Lumin%20Integration%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 5. Enter your Lumin **API Key** and click **Save** ![Lumin dialog for entering an API key, with warning and highlighted Save button to store credentials.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Lumin%20Add%20API%20Key%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) > [!WARNING] > Note: > > You will be unable to view this API Key after saving. --- ## Add a Lumin Event to a Form The **Lumin: Request Signature** workflow event will fill a Lumin Sign template with form submission data and send it to the configured signers. Lumin then emails each signer a link to the document and manages the signing process. 1. [Sign in to your site](/process-automation/docs/sign-in-to-your-site) 2. Navigate to the **Forms** tab and select your desired form ![The Forms tab in the left navigation menu with a form selected on the page.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Select Form - PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 3. Select the **Workflow** tab and click **Add Submission Event** ![](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Workflow, Add Submission Event - PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 1. You can also create an **Approval Event**. The fields are the same for Approval and Submission events. ![Add an approval event button on the Workflow tab.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Add Approval Event - PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 4. In the **Event Type** dropdown, select **Lumin: Request Signature** ![Highlighted event type dropdown shows “Lumin: Request Signature” above an empty label field.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Lumin%20Request%20Signature%20Event%20Type%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 5. Select the **Lumin sign template** you wish to use from your Lumin account ![Form interface highlighting the selected Lumin template, Council Pet Registration Form (Sign).](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Lumin%20Template%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 6. Fill out the event fields: ![Lumin request signature form maps pet registration fields to signer and email details.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Lumin%20Request%20Signature%20Event%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) - **Document Details:** - **Title:** The name of the agreement shown to signers in Lumin. - **Expiry:** The date the signing request expires. Map to a date field on the form for when the signature is due. This will use Lumin’s email notifications to let users know when the signatures are expiring. - **Email Settings:** - **Subject:** The subject line of the email Lumin sends to each signer. - **Message:** An optional message included in the email to signers. - **Signer:** For each signer, set the Name and Email address. - **Form Fields:** After selecting your template, the platform will pull in the template's fields and allow you to map form elements to them. - **Run Conditionally:** This allows you to run the workflow event when specific conditions are met. 7. Click **Save** ![](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Save Workflow - PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) 8. Now, when your form is submitted, the document is created in Lumin and each signer receives an email asking them to sign. The workflow event shows as successful in the submission's workflow status once the request has been sent to Lumin, or shows the error message if it could not be sent. ![Lumin Sign email invites Jane Smith to review and sign the Council Pet Registration Form securely.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Lumin%20Email%20Example%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-12T16%3A13%3A05Z&se=2026-11-12T17%3A13%3A05Z&sr=c&sp=r&sig=mzG5pqbEwHf85hH7eIPSL6CgN%2FaSN9vbq3v0VVJm8bo%3D) Portable Document Format. Application Programming Interface. A set of rules that allows programmers to develop software for a particular operating system without having to be completely familiar with that operating system.