See https://support.esign-app.com for eSign Documentation and Support

How to integrate Confluence Automation Rules with eSign Document Events

Owned by Chris Cairns🔹Digital Rose
Last updated: Oct 16, 2024
1 min read

Overview

eSign Document Management & Training (eDoc) can be integrated with Confluence Automation rules to extend and customize eSign Document usage within your environment.

This capability is introduced through webhooks. The general configuration approach is as follows:

  1. Create a new Rule in Confluence Automation triggered off a webhook.

  2. Add one or more actions to the Rule.

  3. Link the Rule into eDoc by adding the webhook URL to the appropriate event in eSign Space Settings.

This page will walk through an example rule that adds a page label and sends a group email on Release of a new Document Revision.

Confluence Automation is a powerful tool that is available in certain editions of Confluence. Online help for automation is available here: Confluence Cloud automation | Cloud automation Cloud | Atlassian Support

For information and support on Automation please contact Atlassian.

Step 1 - Create a new Rule triggered off a webhook

As a Confluence Administrator, open the Automation menu for the space containing the eSign Documents and press Create Rule

image-20241015-053859.png
Confluence Automation - Entry point

 

Select Incoming webhook, then Next.

image-20241015-054319.png

Then select For each: add a branch > Branch Rule / related entities

Add the following CQL query to the branch rule to allow automation to find the context page.

type=page AND id={{webhook.body.contentId}}

https://support.atlassian.com/cloud-automation/docs/confluence-cloud-automation/

 

Step 2 - Add actions to the Rule - Send email

Select THEN: Add an action > Send email

Complete the 3 email fields with something like the following. Any smart values from the Confluence page or eSign Document (webhook.body) can be added as content.

Field

Example

Field

Example

To

<your name>

Subject

Document {{webhook.body.docId}} revision {{webhook.body.docRev}} has been released

Content

This document has been released. Access it here: {{page.url}}

eSign Document information:
{{webhook.body}}

image-20241015-055222.png
Add Action - Send email

Press Next, then Turn on Rule

Give the rule a name (e.g. “Document Release - Email Notify”)

Step 3 - Link this Webhook to Document Release

In Automation Rule, click on the Incoming Webhook trigger and “Copy URL” to get the Webhook URL into the clipboard.

image-20241015-065627.png

Open eSign Space Settings (for the space containing the Document Working Copies) and paste the webhook URL into the Webhook on Release field.

Save the changes and verify the URL shows on screen refresh.

image-20241015-061057.png

Step 4 - Test the Automation Rule

Take a document revision through the release process in eSign Document. If the rule integration is successful, an email will be sent with a link to the release copy.

 

image-20241015-070253.png
Example email

If it doesn’t work, check the Automation Rule audit log. It can help troubleshoot.

image-20241015-071133.png

 

 

TIP - Add a delay for Release events. In some of our testing the Confluence rule was sometimes unable to find the new Released page as it was created moments before by eSign. Adding the 30s delay action after the webhook trigger node appeared to resolve that issue.

Appendix: Additional Resources

Action - Apply label

In this example, add a dynamic label containing the document Id with the following code:

Field

Example

Field

Example

labels

{{webhook.body.docId}}

image-20241015-055753.png
Add Action - Apply label

Note that Confluence Automation rules run as the Actor configured in the Rule details. Rules that change pages are restricted by page security. For example, eSign can be configured to lock down released pages. In this scenario the Apply label action may be blocked by confluence security.