WebHook File

Owned by Philip Meyer (Unlicensed)
Last updated: 05/10/2023 by Sofiene JUNKER
3 min read

Résumé

Webhook générique d'upload/download de fichiers liés à une entité.
Manipulation en lecture/écriture/suppression via un objet métier depuis une application externe.

Tables

Les tables utilisées sont :

  • sw_data_contractdocument : Table des documents des contrats

  • sw_data_customeraddressdocument : Table des documents des adresses

  • sw_data_customerdocument : Table des documents des tiers

  • sw_data_dealdocument : Table des documents des opportunitĂ©s/affaires

  • sw_data_emaildocument : Tables des documents des emails

  • sw_data_emailtemplatedetaildocument : Table des documents des modèles des emails

  • sw_data_equipmentdocument : Table des documents des Ă©quipements

  • sw_data_eventdocument : Table des documents des Ă©vĂ©nements

  • sw_data_interventiondocument : Table des documents des interventions

  • sw_data_interventionrequestdocument : Table des documents des demandes d'interventions

  • sw_data_marketinginbounddocument : Table des entrants marketing

  • sw_data_productdocument : Table des documents des articles

  • sw_data_productpicture : Table des images des articles

  • sw_data_textblockdetaildocument : Table des documents des bloc textes

Critères d'activation

WHK_File est défini dans la gestion des webhooks du studio.

Particularités

  • L'upload de fichier est limitĂ© en taille.

    • Cette dernière est dĂ©finie selon l’appelant :

      • Addin Outlook → Utilisation des variables suivantes par ordre de prioritĂ© :

        • Variable AddinOutlookDbFromFileMaxSize (par dĂ©faut 5120 Ko)

        • Variable WebhookDbFromFileMaxSize (par dĂ©faut 512 Ko)

        • Variable MobileDbFromFileMaxSize (par dĂ©faut 512 Ko)

      • Addin Gmail → Utilisation des variables suivantes par ordre de prioritĂ© :

        • Variable AddinGmailDbFromFileMaxSize (par dĂ©faut 5120 Ko)

        • Variable WebhookDbFromFileMaxSize (par dĂ©faut 512 Ko)

        • Variable MobileDbFromFileMaxSize (par dĂ©faut 512 Ko)

      • Autre → Utilisation des variables suivantes par ordre de prioritĂ© :

        • Variable WebhookDbFromFileMaxSize (par dĂ©faut 512 Ko)

        • Variable MobileDbFromFileMaxSize (par dĂ©faut 512 Ko)

      • Si aucune variable n’est dĂ©finie ou que les valeurs sont vides, une sĂ©curitĂ© supplĂ©mentaire appliquera une limite Ă  512 Ko

    • L'erreur suivante indiquera que le fichier uploadĂ© dĂ©passe la limite fixĂ©e
      Standard rules error: The file exceeds the allowed size of 512 KB

  • Le bloc "parameters" avec les propriĂ©tĂ©s "entity" et "extension" est obligatoire.
    Il permet de savoir qu'elle entité et extension on veut gérer.

"parameters": { "entity": "value", // entity value (ie : customer, product, contract, ...) "extension": "value" // extension value (document or picture) }

Tableau des entités, extension qui sont gérées.

Entité

Extension

Description

Entité

Extension

Description

contract

document

Contrats/Documents

customeraddress

document

Adresses/Documents

customer

document

Clients/Documents

deal

document

Affaires/Documents

email

document

Emails/Documents

emailtemplatedetail

document

Modèles emails/Documents

equipment

document

Equipements/Documents

equipmenttype

document

Types d'Ă©quipements/Documents

event

document

Evénements/Documents

intervention

document

Interventions/Documents

interventionrequest

document

Demandes d'interventions/Documents

marketinginbound

document

Entrants marketing/Documents

opportunity

document

Opportunités/Documents

product

document

Articles/Documents

product

picture

Articles/Images

prospect

document

Prospects/Documents

suspect

document

Suspects/Documents

textblockdetail

document

Blocs textes/Documents

Fonctionnement

Les exemples ci-dessous sont donnés pour les paramètres suivant :

"parameters": { "entity": "customer", "extension": "document" }

verb: GET
resultType: simple

"file":{ "codefile":"C0000001-FILE1", "parent_ID":"C0000001", "fileBase64":"iVBORw0KGgoAAAANSUhEUgAAAEsAAACQCAYAAABAt5Y ....", "fileName":"plan.png", "description":"vue aérienne" }

verb: GET
resultType: extended

verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura toujours le détail pour "parent_ID" (ici il s'agit de "customer") et selon l'entité des détails complémentaires ou pas (ici on aura "generictype_customerDocumentTag").

verb: PUT

verb: LIST
resultType: simple, extended reprendre les définitions du GET
Ce mode ne retourne pas le champ "fileBase64" pour une question de performances.
A la suite du résultat recherché il suffira de lancer le webhook en mode GET sur le "codeFile" voulu pour récupérer le "fileBase64".

Valeurs possibles pour le tri "orderBy" :

  • fileNameAsc : par nom de fichier ascendant

verb: DEFINITION
En plus de la réponse équivalente aux autres webhooks, on retourne également une propriété complémentaire concernant la taille des fichiers.