Skip to content

Commit

Permalink
docs: for events
Browse files Browse the repository at this point in the history
Signed-off-by: nicolashimmelmann <[email protected]>
  • Loading branch information
nicolashimmelmann committed Jan 10, 2025
1 parent 2062692 commit 40189e5
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<!--
- SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
- SPDX-License-Identifier: AGPL-3.0-or-later
-->
## Webhook Events

Currently, Deck sends the following events that can be received by the [`webhook_listener`](https://docs.nextcloud.com/server/latest/admin_manual/webhook_listeners/index.html) app for Nextcloud Flow automations:

### `CardCreatedEvent`

Fired when a new card is created. Payload:

```text
{
"title": string,
"description": string,
"boardId": int,
"stackId": int,
"lastModified": string,
"createdAt": string
"labels": [
{
"id": int,
"title": string
},
],
"assignedUsers": string[],
"order": int,
"archived": bool,
"commentsUnread": int,
"commentsCount": int,
"owner": string | null,
"lastEditor": string | null,
"duedate": string | null,
"doneAt": string | null,
"deletedAt": string | null
}
```

Note: All timestamps are in ISO8601 format: `2025-01-11T12:34:56+00:00`

### `CardUpdatedEvent`

Fired when a card is changed. Contains the values before and after the update. Payload:

```text
{
"before": {
//...same format as CardCreatedEvent...
},
"after": {
//...same format as CardCreatedEvent...
}
}
```

### `CardDeletedEvent`

Fired when a card is deleted. Payload:

```text
{
//...same as CardCreatedEvent...
}
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ pages:
- API documentation:
- REST API: API.md
- Nextcloud API: API-Nextcloud.md
- Events: events.md
- Developer documentation:
- Data structure: structure.md
- Import documentation:
Expand Down

0 comments on commit 40189e5

Please sign in to comment.