...
| Info |
|---|
Confluence Automation is a powerful tool that is available in certain editions of Confluence. Online help for automation is available here: https://support.atlassian.com/cloud-automation/docs/confluence-cloud-automation/ For information and support on Automation please contact Atlassian. See How to integrate Confluence Automation Rules with eSign Document Events for a related example of setting up an Automation rule and integrating with eSign (Documents). |
Webhook Events
...
Signature Events
Any or all of the following events can be linked to a webhook trigger in Atlassian Automation.
Start Signatures
Signature Invite
Execute Signature
Finalize Signatures
Enable the webhooks in eSign App Settings, available to Confluence Administrators under Apps > Manage Apps.
...
Webhook Data Fields
The webhook provides details of the page, space, user and signature state of the page. Atlassian Automation can access any or all of these fields using the {{ field }} syntax.
Field | Example | Notes |
|---|---|---|
contentId | 34567890 | confluence page ID |
contentTitle | <pagetitle> | |
contentUrl | https://<sitename>.atlassian.net/wiki/spaces/DS/pages/34567890/<pagetitle> | |
contentVersion | 16 | |
eventTs | 2024-11-04T06:09:00Z | |
eventType | EXECUTE | START, INVITE, EXECUTE, FINAL |
pendingCount | 2 | Count of invited but incomplete signatures |
pendingAccountIds | [5f862774075694555, 6669a155fdc3f5003f105b1b] | (Array) Atlassian pending accountIds |
pendingNameList | John Doe, Jane Smith | users with incomplete signatures |
signeeCount | 1 | Count of invited but incomplete signatures |
signeeAccountIds | [5f86277407569888] | (Array) Atlassian signee accountIds |
signeeNameList | John Doe, Jane Smith | users that have signed |
spaceId | 1234567 | |
spaceKey | ACS | |
spaceName | Approved Content Space | |
status | PENDING | PENDING, OPEN, FINAL |
siteUrl | https://<sitename>.atlassian.net/wiki, | |
userId | 0123121421 | user that triggered the event |
userName | John Hancock |
Automation Actions
Email Action example
Tip: To access all fields for development and testing, set up an email action (to self) that includes the following expansion syntax in the body. Note that Jira and Confluence Automation have different syntax for accessing webhook data.
Confluence Automation
| Code Block |
|---|
Event {{ webhook.body.eventType }} received by Confluence automation rule.
This email contains all webhook data: {{ webhook.body }} |
Jira Automation
| Code Block |
|---|
Event {{ webhookData.eventType }} received by Jira automation rule.
All webhook data: {{ webhookData}}. |
Notes
| Info |
|---|
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. |
...