Skip to content

docs: Document tag replacement behaviour for Zendesk updates #3850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Document tag replacement behaviour for Zendesk updates #3850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,18 @@
* Get data related to the organization
* Update a organization

/// warning | Tag Replacement Behavior
When using the Zendesk node's "Update Ticket" operation and specifying the `Tag Names or IDs` field, the entire list of tags on the ticket **will be replaced**. Any tags not included in the update will be removed from the ticket due to how the Zendesk API processes tag updates by default.

Check warning on line 50 in docs/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Passive] 'be removed' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[from-write-good.Passive] 'be removed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md", "range": {"start": {"line": 50, "column": 203}}}, "severity": "WARNING"}

**To avoid accidental tag removal:**

- First retrieve the ticket's tags and merge them with your new tags before updating.
- Alternatively, use the HTTP Request node with Zendesk's `additional_tags` property to add tags without removing existing ones.

Check warning on line 55 in docs/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Weasel] 'Alternatively' is a weasel word!

Raw Output:
{"message": "[from-write-good.Weasel] 'Alternatively' is a weasel word!", "location": {"path": "docs/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md", "range": {"start": {"line": 55, "column": 3}}}, "severity": "WARNING"}

Check warning on line 55 in docs/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.TooWordy] 'Alternatively' is too wordy.

Raw Output:
{"message": "[from-write-good.TooWordy] 'Alternatively' is too wordy.", "location": {"path": "docs/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md", "range": {"start": {"line": 55, "column": 3}}}, "severity": "WARNING"}
- You can also call the ticket's `/tags` endpoint to add tags without replacing existing ones ([Zendesk tags endpoint documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/)).

See the official documentation for details: [Adding tags to tickets without overwriting existing tags](https://developer.zendesk.com/documentation/ticketing/managing-tickets/adding-tags-to-tickets-without-overwriting-existing-tags/).
///

## Templates and examples

<!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
Expand Down
Loading