Skip to main content

Helpdesk Ticket API

Beta License: AGPL-3

This module exposes an API-Key authenticated API to get and create helpdesk tickets

Table of contents

Configuration

To give access to the API to a structure, go to

  • Settings > Technical (debug mode) > Auth API Key

  • Click create and select a user, save.

  • Communicate the API-KEY to those in need to use the API.

Usage

Create tiquets

Example of curl to create a ticket with two variables to fill: - API_KEY: authorized key from the odoo server’s API-KEY (see previows paragraph) - ODOO_URL: target ODOO server’s URL - CONTENT: base64 encoded image to attach to the ticket

Tickets can be created by just one of the following parameters: - partner_ref - partner_email - partner_vat - contract_code

  • “attachments” is an array of objects, optional, each one with the following fields: - filename: name of the file - content: base64 encoded file - mimetype: mimetype of the file

CONTENT=$(base64 image.jpg)

curl -X POST \
  -H "accept: application/json" \
  -H "api-key: $APIKEY" \
  -H "Content-Type: application/json" \
  -d "$(jq -n --arg content "$CONTENT" \
        '{
            summary: "New Ticket",
            description: "this is an API created ticket",
            partner_ref: "2828",
            team: "HTTe_loc",
            category: "HTCa_soft",
            channel: "HTCh_web",
            priority: "0",
            tags: "HTTa_hard,HTTa_tec",
            attachments: [
              {
                filename: "image_name",
                content: $content,
                mimetype: "image/jpg"
              }
            ]
          }')" \
  "$ODOO_URL/api/ticket"

Search tiquets

Tickets can be search by, either:
  • partner_ref, returning those tickets linked to the given partner

  • contract_code, returning those tickets related to the given contract.

Also, and in any of these cases, we can filter by stage, using the stage code to exclude from our result all tickets in a different stage.

curl -X GET \
 -H  "accept: application/json" \
 -H  "api-key: $API_KEY" \
 -H  "Content-Type: application/json" \
 -d '{
   "partner_ref": "10112",
   "stage": "stage_code",
 }' \
 "$ODOO_URL/api/ticket/getlist"

Known issues / Roadmap

There are no issues for the moment.

Bug Tracker

Bugs are tracked on GitLab Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • SomIT SCCL

  • Som Connexio SCCL

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Metadata

Release files for odoo-addon-helpdesk-ticket-api 16.0.1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for odoo-addon-helpdesk-ticket-api 16.0.1.0.2
File Size Uploaded Provenance
odoo-addon-helpdesk_ticket_api-16.0.1.0.2.tar.gz 31.8 kB Without provenance Details

Release files / odoo-addon-helpdesk_ticket_api-16.0.1.0.2.tar.gz

Download URL odoo-addon-helpdesk_ticket_api-16.0.1.0.2.tar.gz
Size 31.8 kB
Tags Source
SHA-256 checksum
How to use checksums
6069bf835d440c4cc6652abb626f6a816e6fd504f69cad9b673eb5bc7b688e4f
BLAKE2b-256 checksum
How to use checksums
4f356c21a14e8994cd42bc07b5e7e9aa7f5881664999fe4187293c565c5a2e13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.10.12

Security for odoo-addon-helpdesk-ticket-api 16.0.1.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page