Zammad icon

Zammad

Consume Zammad REST API

Actions57

Object → Execute Database Migrations

AI-generated

Overview

This node integrates with the Zammad REST API to perform various operations on different resources such as users, organizations, groups, tickets, articles, tags, states, priorities, mentions, online notifications, objects, and user access tokens. It supports CRUD operations (create, read, update, delete), search, and specific actions like executing database migrations on objects. The node is useful for automating and managing Zammad helpdesk data and workflows, such as creating tickets, updating user information, managing tags, or running database migrations programmatically.

Use Case Examples

  1. Creating a new user with custom fields and email address.
  2. Updating an existing ticket with new group assignment and article body.
  3. Listing all organizations or searching users by query.
  4. Executing database migrations on object manager attributes.

Properties

Name Meaning
Authentication The authentication method to use for connecting to the Zammad API. Options include Basic Authentication, OAuth2 Authentication, and Token Authentication.
API The API to use for the operations. Options are REST API or CTI API.
Resource The resource type to operate on, such as user, organization, group, ticket, article, priority, state, tag, mention, online notification, object, or user access token.

Output

JSON

  • id - Unique identifier of the resource or object returned by the API.
  • name - Name of the resource, if applicable.
  • email - Email address for user resources.
  • title - Title of tickets or other relevant resources.
  • body - Content body for articles or ticket updates.
  • customFields - Custom fields set on resources like users, organizations, or tickets.
  • error - Error message returned if an operation fails and continueOnFail is enabled.

Dependencies

  • Zammad API

Troubleshooting

  • Common issues include authentication failures due to incorrect credentials or token expiration. Verify the authentication method and credentials used.
  • API endpoint errors may occur if required parameters are missing or invalid. Ensure all mandatory fields are provided and correctly formatted.
  • Network connectivity issues can prevent API requests from succeeding. Check network access and firewall settings.
  • If the node throws errors related to resource IDs, verify that the IDs exist and are correct for the operation.
  • When using custom fields, ensure the field names match those defined in Zammad to avoid API errors.

Links

Discussion