Tickets

Dans HubSpot, les tickets représentent des demandes d'aide des clients. Les tickets sont suivis tout au long de votre processus d'assistance avec des statuts de pipeline jusqu'à leur fermeture. Les points de terminaison des tickets vous permettent de créer et de gérer des fiches d'informations de ticket ainsi que de synchroniser des données de ticket entre HubSpot et d'autres systèmes. 

Découvrez-en davantage sur les API d'objets, de fiches d'informations, de propriétés et d'associations dans le guide Comprendre le CRM. Pour plus d'informations générales sur les objets et les fiches d'informations dans HubSpot, découvrez comment gérer votre base de données CRM.

Créer des tickets

Pour créer de nouveaux tickets, effectuez une demande de POST à /crm/v3/objects/tickets.

Dans votre demande, incluez les données de votre ticket dans un objet de propriétés. Vous pouvez également ajouter un objet d'association pour associer votre nouveau ticket à des fiches d'informations existantes (par exemple, des contacts ou des entreprises) ou à des activités (par exemple, des réunions ou des notes).

Propriétés

Les détails du ticket sont stockés dans des propriétés de ticket. Il existe des propriétés de ticket HubSpot par défaut, mais vous pouvez également créer des propriétés personnalisées.

Lorsque vous créez un nouveau ticket, vous devez inclure les propriétés suivantes dans votre demande : subject (le nom du ticket), hs_pipeline_stage (le statut du ticket) et, si vous avez plusieurs pipelines, hs_pipeline. Si aucun pipeline n'est spécifié, le pipeline par défaut sera utilisé.

Pour afficher toutes les propriétés disponibles, vous pouvez récupérer une liste des propriétés de ticket de votre compte en effectuant une demande GET à /crm/v3/properties/tickets. Découvrez-en davantage sur l'API des propriétés.

Remarque : Vous devez utiliser l'ID interne d'un statut de ticket ou d'un pipeline lors de la création d'un ticket via l'API. L'ID interne est un numéro, qui sera également retourné lorsque vous récupérerez des tickets via l'API. Vous pouvez trouver le statut de ticket ou l'ID interne d'un pipeline dans les paramètres de votre pipeline de tickets.

Par exemple, pour créer un nouveau ticket, votre demande peut ressembler à ce qui suit :

///Example request body { "properties": { "hs_pipeline": "0", "hs_pipeline_stage": "1", "hs_ticket_priority": "HIGH", "subject": "troubleshoot report" } }

Associations

Lorsque vous créez un nouveau ticket, vous pouvez également associer le ticket à des fiches d'informations ou activités existantes. Dans l'objet d'association, ajoutez les champs suivants :

Use this table to describe parameters / fields
ParameterDescription
toObjectId

L'ID de la fiche d'informations ou de l'activité à laquelle vous souhaitez associer le ticket.

associationTypeId

Un identifiant unique pour indiquer le type d'association entre le ticket et l'autre objet ou activité. Les types d'association par défaut sont répertoriés ici, ou vous pouvez récupérer la valeur en effectuant une demande GET à /crm/v4/associations/{fromObjectType}/{toObjectType}/labels. Découvrez-en davantage sur l'API des associations.

Vous pouvez également inclure le champ label pour attribuer un libellé d'association défini qui décrit l'association. Découvrez-en davantage sur l'association de fiches d'informations via l'API des associations.

Par exemple, pour associer un nouveau ticket à un contact et à une entreprise existants, votre demande ressemblerait à ce qui suit :

///Example request body { "properties": { "hs_pipeline": "0", "hs_pipeline_stage": "1", "hs_ticket_priority": "HIGH", "subject": "troubleshoot report" }, "associations": [ { "to": { "id": 201 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 16 } ] }, { "to": { "id": 301 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 26 } ] }] }

Récupérer des tickets

Vous pouvez récupérer des tickets individuellement ou par lots.

  • Pour récupérer un ticket individuel, effectuez une demande GET à /crm/v3/objects/tickets/{ticketId}.
  • Pour demander une liste de tous les tickets, effectuez une demande GET à /crm/v3/objects/tickets.

Pour ces points de terminaison, vous pouvez inclure les paramètres suivants dans l'URL de la requête : 

Use this table to describe parameters / fields
ParameterDescription
properties

Une liste séparée par des virgules des propriétés à renvoyer dans la réponse. Si le ticket demandé n'a pas de valeur pour une propriété, il n'apparaîtra pas dans la réponse.

propertiesWithHistory

Une liste séparée par des virgules des propriétés actuelles et historiques à renvoyer dans la réponse. Si le ticket demandé n'a pas de valeur pour une propriété, il n'apparaîtra pas dans la réponse.

associations

Une liste séparée par des virgules des objets pour lesquels récupérer les ID associés. Les associations spécifiées qui n'existent pas ne seront pas renvoyées dans la réponse. Découvrez-en davantage sur l'API des associations.

  • Pour récupérer un lot de tickets spécifiques par ID de fiche d'informations ou selon une propriété d'identifiant unique personnalisée, effectuez une demande POST à crm/v3/objects/tickets/batch/read. Le point de terminaison du lot ne peut pas récupérer les associations. Découvrez comment lire par lots les associations avec l'API des associations.

Pour le point de terminaison de lecture par lot, vous pouvez également utiliser le paramètre idProperty facultatif pour récupérer les tickets en fonction d'une propriété d'identifiant unique personnalisée. Par défaut, les valeurs d'identifiant dans la demande font référence à l'ID de fiche d'informations (hs_object_id), de sorte que le paramètre idProperty n'est pas requis lors de la récupération par ID de fiche d'informations. Pour utiliser une propriété de valeur unique personnalisée pour récupérer des tickets, vous devez inclure le paramètre idProperty.

Par exemple, pour récupérer un lot de tickets, votre demande peut ressembler à ce qui suit :

///Example request body with record ID { "properties": [ "subject", "hs_pipeline_stage", "hs_pipeline" ], "inputs": [ { "id": "4444888856" }, { "id": "666699988" } ] }
///Example request body with a unique value property { "properties": [ "subject", "hs_pipeline_stage", "hs_pipeline" ], "idProperty": "uniquepropertyexample", "inputs": [ { "id": "abc" }, { "id": "def" } ] }

Pour récupérer des tickets avec des valeurs actuelles et historiques pour une propriété, votre demande pourrait ressembler à :

///Example request body with record ID (current and historical values) { "propertiesWithHistory": [ "hs_pipeline_stage" ], "inputs": [ { "id": "4444888856" }, { "id": "666699988" } ] }

Mettre à jour des tickets

Vous pouvez mettre à jour des tickets individuellement ou par lots. Pour les tickets existants, l'ID de fiche d'informations est une valeur unique par défaut que vous pouvez utiliser pour mettre à jour le ticket via l'API, mais vous pouvez également identifier et mettre à jour les tickets à l'aide de propriétés d'identifiant unique personnalisées.

  • Pour mettre à jour un ticket individuel avec son ID de fiche d'informations, effectuez une demande PATCH à /crm/v3/objects/tickets/{ticketId} et incluez les données que vous souhaitez mettre à jour.
  • Pour mettre à jour plusieurs tickets, effectuez une demande POST vers /crm/v3/objects/tickets/batch/update. Dans le corps de la requête, incluez un tableau avec les identifiants des tickets et les propriétés que vous souhaitez mettre à jour.

Associer des tickets existants à des fiches d'informations ou activités

Pour associer un ticket à d'autres fiches d'informations de CRM ou à une activité, effectuez une demande PUT à /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Pour récupérer la valeur associationTypeId, reportez-vous à cette liste de valeurs par défaut ou effectuez une demande GET à/crm/v4/associations/{fromObjectType}/{toObjectType}/labels

Découvrez-en davantage sur l'API des associations.

Supprimer une association

Pour supprimer une association entre un ticket et une fiche d'informations ou une activité, effectuez une demande DELETE à l'URL suivante : /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Épingler une activité à un ticket

Remarque : l'épinglage des activités aux tickets via l'API nécessite une authentification OAuth via une application publique. Les applications privées ne peuvent pas être utilisées pour épingler les activités aux tickets.

Vous pouvez épingler une activité à un ticket via l'API en incluant le champ hs_pinned_engagement_id dans votre demande. Dans le champ, incluez l'ID de l'activité à épingler, qui peut être récupéré via les API d'engagement. Vous pouvez épingler une activité par fiche d'informations, et l'activité doit déjà être associée au ticket avant l'épinglage.

Pour définir ou mettre à jour l'activité épinglée d'un ticket, votre demande peut ressembler à :

///Example request body PATCH /crm/v3/objects/tickets/{ticketId} { "properties": { "hs_pinned_engagement_id": 123456789 } }

Vous pouvez également créer un ticket, l'associer à une activité existante et épingler l'activité dans la même demande. Par exemple :

///Example request body POST /crm/v3/objects/tickets { "properties": { "hs_pipeline": "0", "hs_pipeline_stage": "1", "hs_ticket_priority": "HIGH", "subject": "troubleshoot report", "hs_pinned_engagement_id": 123456789 }, "associations": [ { "to": { "id": 123456789 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 227 }] }] }

Supprimer des tickets

Vous pouvez supprimer des tickets individuellement ou par lots, ce qui placera le ticket dans la corbeille dans HubSpot. Vous pourrez ensuite restaurer le ticket dans HubSpot.

Pour supprimer un ticket avec son ID, effectuez une demande DELETE vers /crm/v3/objects/tickets/{ticketId}.

Pour en savoir plus sur la suppression de tickets par lots, cliquez sur l'onglet Points de terminaison en haut de cet article.


Cet article vous a-t-il été utile ?
Ce formulaire est destiné à recueillir les avis sur la documentation pour les développeurs. Si vous souhaitez faire part de votre avis sur les produits HubSpot, veuillez le partager sur le forum des idéesde la communauté.