Passer au contenu principal
Toutes les collectionsApplications et intégrations connectéesAutres applications connectées
Accéder aux Webhooks de Karbon via Zapier
Accéder aux Webhooks de Karbon via Zapier

Accéder à l'API Karbon avec Zapier

Erin Jamison avatar
Écrit par Erin Jamison
Mis à jour il y a plus de 2 mois

Que sont les webhooks?

Les webhooks permettent aux applications d'envoyer automatiquement des données vers d'autres applications.
​

Que sont les webhooks de Karbon?

Karbon envoie automatiquement des avis de webhook pour les actions suivantes :

  • Contact nouveau ou mis à jour

  • Organisation nouvelle ou mise à jour

  • Groupe de clients nouveau ou mis à jour

  • Élément de travail nouveau ou mis à jour

  • Remarque nouvelle ou mise à jour

  • Utilisateur nouvellement créé

  • Nouveaux abonnements créés avec le type Facture

Actuellement, seuls nos webhooks Contact et Organisation sont intégrés à Zapier en tant que déclencheurs. Cependant, les deux autres options sont facilement accessibles via Zapier (qui nécessite un forfait payant).
​

Quels champs de données déclenchent l'envoi du webhook?

Ces champs provoquent l'envoi de nos webhooks. Cependant, si nous voyons plusieurs mises à jour d'un enregistrement dans les 60 secondes, nous n'appelons qu'un seul point de terminaison dans l'abonnement au webhook après l'arrêt des mises à jour.

Contacter

Les contacts nouvellement créés ainsi que les mises à jour des champs suivants déclencheront l'envoi du webhook :

  • Prénom

  • Deuxième prénom

  • Nom de famille

  • Type de contact

  • Adresse courriel (premier, carte de contact en haut à gauche uniquement) (premier adresse uniquement)

  • Numéro de téléphone (premier, carte de contact en haut à gauche uniquement) (premier uniquement)

  • Adresse (première carte de contact en haut à gauche uniquement) (première adresse)

  • Ville (première carte de contact en haut à gauche uniquement) (première adresse)

  • Province (première carte de contact en haut à gauche uniquement) (première adresse)

  • Code postal (première carte de contact en haut à gauche uniquement) (première adresse)

  • Pays (première carte de contact en haut à gauche uniquement) (première adresse)

Organisation

Les organisations nouvellement créées ainsi que les mises à jour des champs suivants déclencheront l'envoi du webhook :

  • Nom

  • Type de contact

  • Identifiant client

  • Site Web (premier site Web)

  • Numéro de téléphone (premier uniquement)

  • Adresse postale (première adresse)

  • Ville (première adresse)

  • État (première adresse)

  • Code postal (première adresse)

  • Pays (première adresse)
    ​

Élément de travail

Les travaux nouvellement créés ainsi que les mises à jour des champs suivants déclencheront l'envoi du webhook :

  • Nom

  • Cessionnaire

  • Statut

  • Date de début

  • Date d'échéance

  • Descriptif

  • Date limite
    ​

Notez

Les notes nouvellement créées ainsi que les mises à jour des champs suivants déclencheront l'envoi du webhook :

  • Nom

  • Descriptif

  • Commentaire

L'utilisateur

  • Les utilisateurs nouvellement créés déclencheront l'envoi du lien de rappel.

Facture

Les nouveaux abonnements créés avec le type Facture enverront une notification à l'URL souscrite lorsque :

  • Une facture a été envoyée à un client.

  • Le statut d'une facture est passé à En attente de paiement, Payé ou Annulé.

Les actions suivantes entraînent également le déclenchement d'un lien de rappel :

  • Paiements partiels sur une facture

  • Déplacement d'une facture entre deux cycles de facturation

Reportez-vous à la documentation de l'API Webhook Subscriptions pour obtenir un exemple complet de la réponse de ce point de terminaison.
​
​

Accéder aux webhooks dans Zapier

Compte développeur Karbon

Pour utiliser notre API, vous avez besoin d'un compte développeur. Demandez-en un ici .

Étape 1 — Créer l'URL cible du webhook

  1. Créer un nouveau Zap

  2. Choisissez Webhooks by Zapier comme déclencheur

    1. Evénement = Crochet de capture

    2. Ignorer la clé enfant

    3. Copier l'URL du webhook
      ​

Étape 2 — Créer un abonnement Webhook

  1. Créer un nouveau Zap

  2. Choisissez Schedule by Zapier comme étape de déclenchement et choisissez n'importe quelle date, cette étape n'est pas nécessaire

  3. Choisir les webhooks par Zapier

    1. Evénement = Demande personnalisée

    2. Méthode = POST

    3. URL = https:// api.karbonhq.com/v3/WebhookSubscriptions

    4. Données =
      {
      "TargetUrl": " https://hooks.zapier.com/hooks/catch/11833388/be89v1o/ ",
      "WebhookType": "Note/WorkItem/Contact (couvre les mises à jour ClientGroup, Contact et Organisation)"
      }

    5. Headers =
      Content-Type : application/json
      Authorization : Ceci vous est envoyé lorsque nous enregistrons votre compte API. Vous devez utiliser le mot Porteur, puis un espace, puis la clé. ie 'Bearer Abcefd-'
      AccessKey : Collez votre clé trouvée dans l'application API au sein de vos applications connectées

    6. Action de test

  4. Votre webhook a bien été créé.

Il est possible d'avoir plusieurs événements webhook envoyés à la même URL, mais vous devrez alors avoir des étapes pour les gérer différemment, il peut donc souvent être plus facile de suivre les étapes ci-dessus pour chacun autre abonnement webhook que vous souhaitez créer.


​

Utilisation des données du webhook

Nos Webhooks renvoient uniquement les données suivantes :

ResourcePermaKey : [Clé]

ResourceType : [WorkItem/Note/Contact/Comment]

ActionType : [inséré/mis à jour/supprimé]

Par conséquent, pour comprendre les données sous-jacentes, une requête GET doit être envoyée au point de terminaison concerné :

WorkItems = https ://api.karbonhq.com/v3/WorkItems/[Clé ]

Contacts = https ://api.karbonhq.com/v3/Contacts/{key }

Organisation = https ://api.karbonhq.com/v3/Organizations/{key }

Groupes de clients = https://api.karbonhq.com/v3/ClientGroups/{key }

Pour agir via Zapier, choisissez une étape d'action Webhooks by Zapier et Event as Custom Request :

Méthode GET et URL comme ci-dessus, mappage dans la clé de l'étape de déclenchement Catch Webhook comme suit

Ajouter des en-têtes

Si vous avez besoin d'assistance, nous vous proposons notre Plan de service annuel technique.

Avez-vous trouvé la réponse à votre question ?