.png)
TOPdesk Integration Guide
Connect TOPdesk service-management resources with enterprise applications through REST APIs, scheduled workflows, and verified event-driven capabilities.
TOPdesk integration options at a glance
TOPdesk provides REST APIs for reading and modifying service-management resources such as Incidents, Persons, Operators, Assets, Changes, and Problems. Martini can consume these APIs through reusable workflows that manage authentication, pagination, mapping, validation, retries, and synchronization checkpoints. TOPdesk may provide event-driven or outbound notification capabilities for selected use cases, but universal webhook coverage is not confirmed and must be verified for each tenant and object. Attachments are supported in the product, while object-level attachment API operations require confirmation. API token authentication, restricted integration accounts, and Martini secrets provide the foundation for secure integrations.
Common TOPdesk integration patterns
Common TOPdesk data objects used in integrations
Authentication and security considerations
API token authentication
TOPdesk REST integrations use an API token associated with an operator or integration account. Confirm the required authentication format, permissions, API version, and accessible modules for the target tenant.
Credential protection
Store the TOPdesk base URL and API token in Martini environment configuration and secrets rather than workflow definitions. Do not write authorization headers or token values to logs.
Least privilege and data protection
- Use a dedicated TOPdesk integration account with only the permissions required by the workflows.
- Protect incident descriptions, notes, personal information, and attachments according to organizational data policies.
- Filter sensitive operational content before sending TOPdesk data to external applications.
- Rotate credentials according to organizational policy and any applicable TOPdesk controls.
Operational considerations for TOPdesk integrations
Pagination and synchronization windows
TOPdesk collections may be paginated. Follow documented limits, maintain checkpoints or timestamps where supported, and use overlap windows when timestamp precision or ordering could cause missed updates.
Rate limits and retries
Confirm rate limits for the target environment. Throttle requests, limit concurrency, use exponential backoff for transient failures, and distinguish rate-limit or transport errors from permanent validation and authorization errors.
Idempotency and relationships
Use stable source identifiers and deterministic matching before creating Incidents or Persons. Resolve Persons, Operators, Assets, branches, categories, and operator groups before writing related objects.
Tenant-specific schemas
TOPdesk environments may differ in custom fields, required fields, statuses, priorities, categories, branches, departments, and permissions. Keep mappings configurable and validate them before production activation.
Testing and observability
Test representative objects, status transitions, missing references, pagination, attachments, and failure responses. Log safe correlation identifiers, TOPdesk object IDs, workflow execution IDs, retry counts, and final failure reasons.
Why use Martini instead of scripts or point-to-point integrations?
Reusable integration workflows
Martini centralizes TOPdesk authentication, pagination, response validation, mapping, business rules, and error handling in reusable workflows instead of duplicating logic across scripts.
Reliable orchestration
Scheduled, API-led, and selectively event-driven workflows can coordinate TOPdesk with monitoring, identity, CRM, development, and enterprise applications while preserving checkpoints and correlation identifiers.
Controlled transformation
Martini provides a maintainable place to normalize TOPdesk statuses, priorities, identifiers, relationships, custom fields, and sensitive content before data reaches another system.
Operational maintainability
- Apply bounded retries and separate transient failures from business validation errors.
- Keep tenant-specific configuration and secrets outside workflow logic.
- Expose controlled APIs for upstream systems without requiring point-to-point TOPdesk logic in every application.
- Support monitoring, troubleshooting, and controlled deployment of integration changes.