Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
stylenone

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.

Info

Confluence Automation is a powerful tool that is supported in Confluence Premium and above. Online help for atomation is available here: https://support.atlassian.com/cloud-automation/docs/confluence-cloud-automation/

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

...

Select Incoming webhook, then Next.

...

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.

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

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

Step 2A - Add actions to the Rule - Send email

Select THEN: Add an action > Send email

Complete the 3 email fields with something like this:

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}}

...

Press Next.

Step 2B - Add actions to the Rule - Apply label

Select THEN: Add an action > Apply label

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

Field

Example

labels

{{webhook.body.docId}}

...

Press Next

Press Turn on Rule and give it a name (e.g. “Document Release - Notify and Label”)

Step 3 - Link this Webhook to the eSign Document Release Event.

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

...

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.

...

Step 4 - Test the Automation Rule