Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
218 changes: 217 additions & 1 deletion apps/docs/content/docs/en/triggers/confluence.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
color="#E0E0E0"
/>

Confluence provides 16 triggers for automating workflows based on events.
Confluence provides 23 triggers for automating workflows based on events.

## Triggers

Expand Down Expand Up @@ -98,6 +98,49 @@ Trigger workflow when an attachment is removed in Confluence
| `files` | file[] | Attachment file content downloaded from Confluence \(if includeFileContent is enabled with credentials\) |


---

### Confluence Attachment Updated

Trigger workflow when an attachment is updated in Confluence

#### Configuration

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookSecret` | string | No | Optional secret to validate webhook deliveries from Confluence using HMAC signature |
| `confluenceDomain` | string | No | Your Confluence Cloud domain |
| `confluenceEmail` | string | No | Your Atlassian account email. Required together with API token to download attachment files. |
| `confluenceApiToken` | string | No | API token from https://id.atlassian.com/manage-profile/security/api-tokens. Required to download attachment file content. |
| `includeFileContent` | boolean | No | Download and include actual file content from attachments. Requires email, API token, and domain. |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `timestamp` | number | Timestamp of the webhook event \(Unix epoch milliseconds\) |
| `userAccountId` | string | Account ID of the user who triggered the event |
| `accountType` | string | Account type \(e.g., customer\) |
| `id` | number | Content ID |
| `title` | string | Content title |
| `contentType` | string | Content type \(page, blogpost, comment, attachment\) |
| `version` | number | Version number |
| `spaceKey` | string | Space key the content belongs to |
| `creatorAccountId` | string | Account ID of the creator |
| `lastModifierAccountId` | string | Account ID of the last modifier |
| `self` | string | URL link to the content |
| `creationDate` | number | Creation timestamp \(Unix epoch milliseconds\) |
| `modificationDate` | number | Last modification timestamp \(Unix epoch milliseconds\) |
| `attachment` | object | attachment output from the tool |
| ↳ `mediaType` | string | MIME type of the attachment |
| ↳ `fileSize` | number | File size in bytes |
| ↳ `parent` | object | parent output from the tool |
| ↳ `id` | number | Container page/blog ID |
| ↳ `title` | string | Container page/blog title |
| ↳ `contentType` | string | Container content type |
| `files` | file[] | Attachment file content downloaded from Confluence \(if includeFileContent is enabled with credentials\) |


---

### Confluence Blog Post Created
Expand Down Expand Up @@ -142,6 +185,28 @@ Trigger workflow when a blog post is removed in Confluence
| `accountType` | string | Account type \(e.g., customer\) |


---

### Confluence Blog Post Restored

Trigger workflow when a blog post is restored from trash in Confluence

#### Configuration

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookSecret` | string | No | Optional secret to validate webhook deliveries from Confluence using HMAC signature |
| `confluenceDomain` | string | No | Your Confluence Cloud domain |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `timestamp` | number | Timestamp of the webhook event \(Unix epoch milliseconds\) |
| `userAccountId` | string | Account ID of the user who triggered the event |
| `accountType` | string | Account type \(e.g., customer\) |


---

### Confluence Blog Post Updated
Expand Down Expand Up @@ -242,6 +307,45 @@ Trigger workflow when a comment is removed in Confluence
| ↳ `self` | string | URL link to the parent content |


---

### Confluence Comment Updated

Trigger workflow when a comment is updated in Confluence

#### Configuration

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookSecret` | string | No | Optional secret to validate webhook deliveries from Confluence using HMAC signature |
| `confluenceDomain` | string | No | Your Confluence Cloud domain |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `timestamp` | number | Timestamp of the webhook event \(Unix epoch milliseconds\) |
| `userAccountId` | string | Account ID of the user who triggered the event |
| `accountType` | string | Account type \(e.g., customer\) |
| `id` | number | Content ID |
| `title` | string | Content title |
| `contentType` | string | Content type \(page, blogpost, comment, attachment\) |
| `version` | number | Version number |
| `spaceKey` | string | Space key the content belongs to |
| `creatorAccountId` | string | Account ID of the creator |
| `lastModifierAccountId` | string | Account ID of the last modifier |
| `self` | string | URL link to the content |
| `creationDate` | number | Creation timestamp \(Unix epoch milliseconds\) |
| `modificationDate` | number | Last modification timestamp \(Unix epoch milliseconds\) |
| `comment` | object | comment output from the tool |
| ↳ `parent` | object | parent output from the tool |
| ↳ `id` | number | Parent page/blog ID |
| ↳ `title` | string | Parent page/blog title |
| ↳ `contentType` | string | Parent content type \(page or blogpost\) |
| ↳ `spaceKey` | string | Space key of the parent |
| ↳ `self` | string | URL link to the parent content |


---

### Confluence Label Added
Expand Down Expand Up @@ -346,6 +450,40 @@ Trigger workflow when a page is moved in Confluence
| `accountType` | string | Account type \(e.g., customer\) |


---

### Confluence Page Permissions Updated

Trigger workflow when page permissions are changed in Confluence

#### Configuration

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookSecret` | string | No | Optional secret to validate webhook deliveries from Confluence using HMAC signature |
| `confluenceDomain` | string | No | Your Confluence Cloud domain |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `timestamp` | number | Timestamp of the webhook event \(Unix epoch milliseconds\) |
| `userAccountId` | string | Account ID of the user who triggered the event |
| `accountType` | string | Account type \(e.g., customer\) |
| `id` | number | Content ID |
| `title` | string | Content title |
| `contentType` | string | Content type \(page, blogpost, comment, attachment\) |
| `version` | number | Version number |
| `spaceKey` | string | Space key the content belongs to |
| `creatorAccountId` | string | Account ID of the creator |
| `lastModifierAccountId` | string | Account ID of the last modifier |
| `self` | string | URL link to the content |
| `creationDate` | number | Creation timestamp \(Unix epoch milliseconds\) |
| `modificationDate` | number | Last modification timestamp \(Unix epoch milliseconds\) |
| `page` | object | page output from the tool |
| ↳ `permissions` | json | Updated permissions object for the page |


---

### Confluence Page Removed
Expand All @@ -368,6 +506,28 @@ Trigger workflow when a page is removed or trashed in Confluence
| `accountType` | string | Account type \(e.g., customer\) |


---

### Confluence Page Restored

Trigger workflow when a page is restored from trash in Confluence

#### Configuration

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookSecret` | string | No | Optional secret to validate webhook deliveries from Confluence using HMAC signature |
| `confluenceDomain` | string | No | Your Confluence Cloud domain |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `timestamp` | number | Timestamp of the webhook event \(Unix epoch milliseconds\) |
| `userAccountId` | string | Account ID of the user who triggered the event |
| `accountType` | string | Account type \(e.g., customer\) |


---

### Confluence Page Updated
Expand Down Expand Up @@ -416,6 +576,32 @@ Trigger workflow when a new space is created in Confluence
| ↳ `self` | string | URL link to the space |


---

### Confluence Space Removed

Trigger workflow when a space is removed in Confluence

#### Configuration

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookSecret` | string | No | Optional secret to validate webhook deliveries from Confluence using HMAC signature |
| `confluenceDomain` | string | No | Your Confluence Cloud domain |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `timestamp` | number | Timestamp of the webhook event \(Unix epoch milliseconds\) |
| `userAccountId` | string | Account ID of the user who triggered the event |
| `accountType` | string | Account type \(e.g., customer\) |
| `space` | object | space output from the tool |
| ↳ `key` | string | Space key |
| ↳ `name` | string | Space name |
| ↳ `self` | string | URL link to the space |


---

### Confluence Space Updated
Expand All @@ -442,6 +628,35 @@ Trigger workflow when a space is updated in Confluence
| ↳ `self` | string | URL link to the space |


---

### Confluence User Created

Trigger workflow when a new user is added to Confluence

#### Configuration

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookSecret` | string | No | Optional secret to validate webhook deliveries from Confluence using HMAC signature |
| `confluenceDomain` | string | No | Your Confluence Cloud domain |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `timestamp` | number | Timestamp of the webhook event \(Unix epoch milliseconds\) |
| `userAccountId` | string | Account ID of the user who triggered the event |
| `accountType` | string | Account type \(e.g., customer\) |
| `user` | object | user output from the tool |
| ↳ `accountId` | string | Account ID of the new user |
| ↳ `accountType` | string | Account type \(e.g., atlassian, app\) |
| ↳ `displayName` | string | Display name of the user |
| ↳ `emailAddress` | string | Email address of the user \(may not be available due to GDPR/privacy settings\) |
| ↳ `publicName` | string | Public name of the user |
| ↳ `self` | string | URL link to the user profile |


---

### Confluence Webhook (All Events)
Expand Down Expand Up @@ -472,5 +687,6 @@ Trigger workflow on any Confluence webhook event
| `space` | json | Space object \(present in space events\) |
| `label` | json | Label object \(present in label events\) |
| `content` | json | Content object \(present in label events\) |
| `user` | json | User object \(present in user events\) |
| `files` | file[] | Attachment file content \(present in attachment events when includeFileContent is enabled\) |

Loading
Loading