Les données sont transférées au format JSON. Il existe trois formats différents :
Structuré
Ce format contient toutes les données sous une forme clairement structurée et convient particulièrement aux développeurs et intégrateurs de logiciels.Plat
Il s'agit d'un format avec une structure de données simplifiée. Il est particulièrement adapté à un traitement ultérieur dans des outils à faible code.Héritage/Legacy - (déprécié)
Ce format correspond au format utilisé dans CONNECT 2.0.
Détails généraux
Protocole : HTTPS
Codage du texte : UTF-8
Méthode de transfert : POST
Notez que les webhooks nécessitent des connexions HTTPS sécurisées (par exemple "https://your-server.com/enpoint"). Vous ne pouvez pas utiliser de connexion non-SSL/TLS et votre serveur doit fournir un certificat valide et non auto-signé.
Exemple de données de requête
Les exemples suivants montrent le corps de la demande dans les formats disponibles:
Structuré - Données de demande de la société Push
Structuré - Données de demande de la société Push
{
"company": {
"id": "ZWNob2JvdA",
"name": "WebhookTest GmbH",
"description": "Ich bin eine Test-Firma um deine Webhooks zu testen!",
"descriptionEn": "I am a test company to test your webhook implementation!",
"streetNameAndNumber": "Teststraße 1",
"streetName": "Teststraße",
"streetNumber": "1",
"location": "Karlsruhe",
"postalCode": "76131",
"country": "Deutschland",
"countryCode": "DE",
"legalForm": "GmbH",
"registerNumber": "HRB123456",
"registerName": "Mannheim",
"registerTypeText": "Handelsregisternummer",
"registerStatusKey": "consolidated",
"registerStatusText": "Aktiv",
"foundedYear": 1970,
"taxId": "DE123456789",
"email": "test@webhooktest.de",
"phone": "+49 721 123456",
"fax": "+49 721 1234567",
"connectUrl": "https://connect.echobotsales.de/#/company/ZWNob2JvdA",
"website": "webhooktest.de",
"domains": [
"webhooktest.io",
"webhooktest.de"
],
"employeesNum": 101,
"socialProfiles": {
"xing": [
"https://www.xing.com/pages/webhooktest",
"https://www.xing.com/companies/webhooktest"
],
"youtube": [
"https://www.youtube.com/webhooktest"
],
"facebook": [
"https://www.facebook.com/webhooktest"
],
"twitter": [
"https://twitter.com/webhooktest"
],
"linkedin": [
"https://www.linkedin.com/company/webhooktest"
],
"instagram": [
"https://instagram.com/webhooktest"
]
},
"shopTechnologies": [],
"webTechnologies": [
"WordPress",
"Responsive Website"
],
"classification": [
{
"type": "nace",
"code": "01.13",
"divisionText": "Landwirtschaft, Jagd und damit verbundene Tätigkeiten",
"text": "Anbau von Gemüse und Melonen sowie Wurzeln und Knollen"
},
{
"type": "wz",
"code": "01.13.01",
"divisionText": "Landwirtschaft, Jagd und damit verbundene Tätigkeiten",
"classText": "Anbau von Gemüse und Melonen sowie Wurzeln und Knollen",
"text": "Anbau von Gemüse und Melonen"
},
{
"type": "echobotIndustry",
"code": "eb2_agriculture.farming",
"divisionText": "Landwirtschaft",
"text": "Agrar-Landwirtschaft"
}
],
"finRevenueText": "100.000 €",
"finRevenue": 100000,
"finRevenueCurrency": "EUR",
"finRevenueSource": "reported_estimate",
"finRevenueSourceText": "geschätzt",
"finEarnings": 100000,
"finEarningsText": "100.000 €",
"finEarningsCurrency": "EUR",
"finBalanceSheetTotal": 100000,
"finBalanceSheetTotalText": "100.000 €",
"finBalanceSheetTotalCurrency": "EUR",
"finReportingType": "annual",
"finReportingTypeText": "Jahresabschluss",
"finReportingYear": 2020
},
"meta": {
"customId": "123456",
"userId": "testwebhook@webhook.de"
}
}
Structuré - Données de demande de contact / de piste
Structuré - Données de demande de contact / de piste
{
"contact": {
"id": "Y29ubmVjdA",
"salutation": "Herr",
"gender": "male",
"title": "",
"firstName": "Max",
"lastName": "Mustermann",
"jobTitle": "Geschäftsführer",
"jobTitleEn": "Managing Director",
"departments": {
"management_department": "Unternehmensführung"
},
"hierarchies": {
"top_management": "Top-Management"
},
"country": "Deutschland",
"countryCode": "DE",
"location": "Hamburg",
"phone": "+49 721 123456",
"phoneDirect": "+49 721 1234569",
"mobile": "+49 1512 1234567",
"fax": "+49 721 1234567",
"email": "max.mustermann@webhook.de",
"emailStatusKey": "seen",
"emailValidationStatusKey": "valid",
"emailStatusText": "gesehen, validiert",
"socialProfiles": {
"xing": [
"https://www.xing.com/profile/Max_Mustermann"],
"linkedin": [
"https://de.linkedin.com/in/maxmustermann"
]
},
"furtherSources": [
"https://webhook.io/contacts"
],
"companyId": "ZWNob2JvdA",
"companyPhone": "+49 721 123456"
},
"company": {
"id": "ZWNob2JvdA",
"name": "WebhookTest GmbH",
"description": "Ich bin eine Test-Firma um deine Webhooks zu testen!",
"descriptionEn": "I am a test company to test your webhook implementation!",
"streetNameAndNumber": "Teststraße 1",
"streetName": "Teststraße",
"streetNumber": "1",
"location": "Karlsruhe",
"postalCode": "76131",
"country": "Deutschland",
"countryCode": "DE",
"legalForm": "GmbH",
"registerNumber": "HRB123456",
"registerName": "Mannheim",
"registerTypeText": "Handelsregisternummer",
"registerStatusKey": "consolidated",
"registerStatusText": "Aktiv",
"foundedYear": 1970,
"taxId": "DE123456789",
"email": "test@webhooktest.de",
"phone": "+49 721 123456",
"fax": "+49 721 1234567",
"connectUrl": "https://connect.echobotsales.de/#/company/ZWNob2JvdA",
"website": "webhooktest.de",
"domains": [
"webhooktest.io",
"webhooktest.de"
],
"employeesNum": 101,
"socialProfiles": {
"xing": [
"https://www.xing.com/pages/webhooktest",
"https://www.xing.com/companies/webhooktest"
],
"youtube": [
"https://www.youtube.com/webhooktest"
],
"facebook": [
"https://www.facebook.com/webhooktest"
],
"twitter": [
"https://twitter.com/webhooktest"
],
"linkedin": [
"https://www.linkedin.com/company/webhooktest"
],
"instagram": [
"https://instagram.com/webhooktest"
]
},
"shopTechnologies": [],
"webTechnologies": [
"WordPress",
"Responsive Website"
],
"classification": [
{
"type": "nace",
"code": "01.13",
"divisionText": "Landwirtschaft, Jagd und damit verbundene Tätigkeiten",
"text": "Anbau von Gemüse und Melonen sowie Wurzeln und Knollen"
},
{
"type": "wz",
"code": "01.13.01",
"divisionText": "Landwirtschaft, Jagd und damit verbundene Tätigkeiten",
"classText": "Anbau von Gemüse und Melonen sowie Wurzeln und Knollen",
"text": "Anbau von Gemüse und Melonen"
},
{
"type": "echobotIndustry",
"code": "eb2_agriculture.farming",
"divisionText": "Landwirtschaft",
"text": "Agrar-Landwirtschaft"
}
],
"finRevenueText": "100.000 €",
"finRevenue": 100000,
"finRevenueCurrency": "EUR",
"finRevenueSource": "reported_estimate",
"finRevenueSourceText": "geschätzt",
"finEarnings": 100000,
"finEarningsText": "100.000 €",
"finEarningsCurrency": "EUR",
"finBalanceSheetTotal": 100000,
"finBalanceSheetTotalText": "100.000 €",
"finBalanceSheetTotalCurrency": "EUR",
"finReportingType": "annual",
"finReportingTypeText": "Jahresabschluss",
"finReportingYear": 2020
},
"meta": {
"customId": "123456",
"userId": "testwebhook@webhook.de"
}
}
Flat - Push Company Request Data
Flat - Push Company Request Data
{
"company": {
"id": "ZWNob2JvdA",
"name": "WebhookTest GmbH",
"description": "Ich bin eine Test-Firma um deine Webhooks zu testen!",
"descriptionEn": "I am a test company to test your webhook implementation!",
"streetNameAndNumber": "Teststraße 1",
"streetName": "Teststraße",
"streetNumber": "1",
"location": "Karlsruhe",
"postalCode": "76131",
"country": "Deutschland",
"countryCode": "DE",
"legalForm": "GmbH",
"registerNumber": "HRB123456",
"registerName": "Mannheim",
"registerTypeText": "Handelsregisternummer",
"registerStatusKey": "consolidated",
"registerStatusText": "Aktiv",
"foundedYear": 2011,
"taxId": "DE123456789",
"email": "test@webhooktest.de",
"phone": "+49 721 123456",
"fax": "+49 721 1234567",
"connectUrl": "https://connect.echobotsales.de/#/company/ZWNob2JvdA",
"website": "webhooktest.de",
"domain": "webhooktest.io",
"employeesNum": 101,
"xing": "https://www.xing.com/pages/webhooktest",
"linkedin": "https://www.linkedin.com/company/webhooktest",
"twitter": "https://twitter.com/webhooktest",
"facebook": "https://www.facebook.com/webhooktest",
"youtube": "https://www.youtube.com/webhooktest",
"pinterest": "https://pinterest.com/webhooktest",
"instagram": "https://instagram.com/webhooktest",
"shopTechnologies": "",
"webTechnologies": "WordPress, Responsive Website",
"wzCodes": "01.13.01",
"naceDivision": "01",
"naceDivisionText": "Landwirtschaft, Jagd und damit verbundene Tätigkeiten",
"naceClass": "01.13",
"naceClassText": "Anbau von Gemüse und Melonen sowie Wurzeln und Knollen",
"wzCode": "01.13.01",
"wzCodeText": "Anbau von Gemüse und Melonen",
"echobotIndustryCodes": "eb2_agriculture.farming",
"echobotIndustryCode": "eb2_agriculture.farming",
"echobotIndustryCodeText": "Agrar-Landwirtschaft",
"industryDivisionText": "Landwirtschaft",
"finRevenueText": "100.000 €",
"finRevenue": 100000,
"finRevenueCurrency": "EUR",
"finRevenueSource": "reported_estimate",
"finRevenueSourceText": "geschätzt",
"finEarnings": 100000,
"finEarningsText": "100.000 €",
"finEarningsCurrency": "EUR",
"finBalanceSheetTotal": 100000,
"finBalanceSheetTotalText": "100.000 €",
"finBalanceSheetTotalCurrency": "EUR",
"finReportingType": "annual",
"finReportingTypeText": "Jahresabschluss",
"finReportingYear": 2020
},
"meta": {
"customId": "123456",
"userId": "testwebhook@webhook.de"
}
}
Données de demande de contact plat - Push
Données de demande de contact plat - Push
{
"contact": {
"id": "Y29ubmVjdA",
"salutation": "Herr",
"gender": "male",
"title": "",
"firstName": "Max",
"lastName": "Mustermann",
"jobTitle": "Geschäftsführer",
"jobTitleEn": "Managing Director",
"departmentKey": "management_department",
"departmentText": "Unternehmensführung",
"departmentsText": "Unternehmensführung",
"hierarchyKey": "top_management",
"hierarchyText": "Top-Management",
"hierarchiesText": "Top-Management",
"country": "Deutschland",
"countryCode": "DE",
"location": "Karlsruhe, Baden-Württemberg",
"phone": "+49 721 123456",
"phoneDirect": "+49 721 1234569",
"mobile": "+49 1512 1234567",
"fax": "+49 721 1234567",
"email": "max.mustermann@webhook.de",
"emailStatusKey": "seen",
"emailValidationStatusKey": "valid",
"emailStatusText": "",
"socialXing": "https://www.xing.com/profile/Max_Mustermann",
"socialLinkedin": "https://de.linkedin.com/in/maxmustermann",
"furtherSources": "https://webhook.io/contacts",
"companyId": "ZWNob2JvdA",
"companyPhone": "+49 721 123456"
},
"company": {
"id": "ZWNob2JvdA",
"name": "WebhookTest GmbH",
"description": "Ich bin eine Test-Firma um deine Webhooks zu testen!",
"descriptionEn": "I am a test company to test your webhook implementation!",
"streetNameAndNumber": "Teststraße 1",
"streetName": "Teststraße",
"streetNumber": "1",
"location": "Karlsruhe",
"postalCode": "76131",
"country": "Deutschland",
"countryCode": "DE",
"legalForm": "GmbH",
"registerNumber": "HRB123456",
"registerName": "Mannheim",
"registerTypeText": "Handelsregisternummer",
"registerStatusKey": "consolidated",
"registerStatusText": "Aktiv",
"foundedYear": 2011,
"taxId": "DE123456789",
"email": "test@webhooktest.de",
"phone": "+49 721 123456",
"fax": "+49 721 1234567",
"connectUrl": "https://connect.echobotsales.de/#/company/ZWNob2JvdA",
"website": "webhooktest.de",
"domain": "webhooktest.io",
"employeesNum": 101,
"xing": "https://www.xing.com/pages/webhooktest",
"linkedin": "https://www.linkedin.com/company/webhooktest",
"twitter": "https://twitter.com/webhooktest",
"facebook": "https://www.facebook.com/webhooktest",
"youtube": "https://www.youtube.com/webhooktest",
"pinterest": "https://pinterest.com/webhooktest",
"instagram": "https://instagram.com/webhooktest",
"shopTechnologies": "",
"webTechnologies": "WordPress, Responsive Website",
"wzCodes": "01.13.01",
"naceDivision": "01",
"naceDivisionText": "Landwirtschaft, Jagd und damit verbundene Tätigkeiten",
"naceClass": "01.13",
"naceClassText": "Anbau von Gemüse und Melonen sowie Wurzeln und Knollen",
"wzCode": "01.13.01",
"wzCodeText": "Anbau von Gemüse und Melonen",
"echobotIndustryCodes": "eb2_agriculture.farming",
"echobotIndustryCode": "eb2_agriculture.farming",
"echobotIndustryCodeText": "Agrar-Landwirtschaft",
"industryDivisionText": "Landwirtschaft",
"finRevenueText": "100.000 €",
"finRevenue": 100000,
"finRevenueCurrency": "EUR",
"finRevenueSource": "reported_estimate",
"finRevenueSourceText": "geschätzt",
"finEarnings": 100000,
"finEarningsText": "100.000 €",
"finEarningsCurrency": "EUR",
"finBalanceSheetTotal": 100000,
"finBalanceSheetTotalText": "100.000 €",
"finBalanceSheetTotalCurrency": "EUR",
"finReportingType": "annual",
"finReportingTypeText": "Jahresabschluss",
"finReportingYear": 2020
},
"meta": {
"customId": "123456",
"userId": "testwebhook@webhook.de"
}
}
Vous trouverez des informations sur le format des données héritées dans les instructions séparées.
Types de propriétés
Texte | Dealfront | Valeurs de texte. |
Numéro de téléphone | +49 1234 567890 | Les numéros de téléphone sont fournis sous forme de champs de texte formatés en tant que numéro de téléphone entièrement qualifié (FQTN) conformément à la norme ITU-T E.123. |
Url | dealfront.com | Les urls sont des champs de texte comprenant l'url complète, y compris le protocole. |
Clés | consolidées | Les clés sont des champs de texte comportant un ensemble fixe de valeurs possibles. Ces valeurs ne seront pas traduites. Préférez ces champs si vous prévoyez de construire une logique d'application. Dans de nombreux cas, les données comprennent une clé ainsi qu'une traduction lisible par l'homme. Dans ce cas, le champ clé porte généralement le suffixe "Key" et la propriété lisible par l'homme le suffixe "Text". |
Chiffres | 1000 | Les nombres ne sont toujours que le nombre lui-même, sans données supplémentaires comme la devise. Les données comprennent souvent deux variantes de la même information : La valeur numérique et, par exemple, la devise dans des propriétés distinctes et la même combinaison dans un champ de texte. La première option est la plus efficace si vous envisagez de traiter les données dans votre application. La deuxième option vous permet d'écrire simplement la valeur dans un champ de texte et elle est formatée selon la langue du webhook sélectionné. |
L'objet société
Il contient les données d'une seule entreprise. Toutes les demandes incluent une seule entreprise.
id | string | Identifiant Dealfront pour cette entreprise |
name | chaîne de caractères | Nom complet de la société |
description | chaîne de caractères | Description de l'entreprise. La description est rédigée dans la langue du pays dans lequel l'entreprise est basée. |
descriptionEn | chaîne de caractères | Description de la société en anglais. Il s'agit d'une traduction de la description originale de l'entreprise. |
streetNameAndNumber | chaîne de caractères | Rue et numéro combinés dont l'ordre dépend du pays où l'entreprise est basée. |
streetName | chaîne de caractères | Nom de la rue sans numéro |
streetNumber | chaîne de caractères | Adresse, numéro de rue |
location | chaîne de caractères | Adresse, ville |
postalCode | chaîne de caractères | Adresse, code postal |
country | chaîne de caractères | Nom du pays dans la langue des données du webhook sélectionné. |
countryCode | chaîne de caractères | Code pays ISO. |
legalForm | chaîne de caractères | Type de société, par exemple "GmbH", "Ltd". |
registerNumber | chaîne de caractères | Numéro de l'entreprise dans le registre officiel. |
registerName | chaîne de caractères | Nom du registre officiel dans lequel l'entreprise est enregistrée. La langue est la langue utilisée dans ce registre. |
registerTypeText | chaîne de caractères | Il s'agit de la façon dont l'enregistrement est nommé dans ce registre, par exemple en Allemagne "Handelsregisternummer". |
registerStatusKey | annuel | consolidé | Statut de l'enregistrement sous forme de clé. |
registerStatusText | chaîne de caractères | Représentation lisible par l'homme du statut d'enregistrement dans le langage de données du webhook.
Elle inclut également l'information si une entreprise est protégée par la publicité (comme certaines entreprises au Danemark: https://datacvr.virk.dk/artikel/vilkaar-og-betingelser) |
foundedYear | nombre | Année de création de l'entreprise, par exemple 1995. |
taxId | chaîne de caractères | Identifiant fiscal / identifiant de TVA. |
chaîne de caractères | Adresse électronique générale de l'entreprise. Généralement info@ ou similaire. | |
phone | chaîne de caractères | Numéro de téléphone général de l'entreprise |
fax | chaîne de caractères | Numéro de fax de l'entreprise |
connectUrl | chaîne de caractères, url | Lien vers l'application web connect où les utilisateurs peuvent trouver toutes les informations sur l'entreprise. |
website | chaîne de caractères | Site web de l'entreprise |
classification |
| Classification de l'entreprise. Au moment de la rédaction de ce document, nous prenons en charge le code nace (Classification statistique des activités économiques dans la Communauté européenne - Wikipedia), les codes wz et une classification interne Dealfront.
Dans le format structuré du webhook, les classifications sont fournies sous la forme d'une liste, où chaque élément possède les caractéristiques suivantes
Dans le format plat, la structure des données est simplifiée et représentée par des propriétés de l'objet "entreprise" lui-même. Si une entreprise possède plusieurs classifications du même type, certaines données ne sont disponibles que pour la classification la plus pertinente. Veuillez vous référer aux exemples ci-dessus pour plus d'informations. |
finRevenue | nombre | Revenu de l'entreprise |
finRevenueCurrency | chaîne de caractères | ISO actuel de finRevenue |
finRevenueSource | déclaré | estimé | Selon le pays et le type d'entreprise, le revenu peut être officiellement déclaré ou estimé. |
finRevenueText | chaîne de caractères | Revenu incluant la devise et formaté selon la langue du webhook. |
finEarnings |
| Bénéfices de l'entreprise, voir finRevenue pour plus de détails sur les variations de format. |
finBalanceSheetTotal |
| Bilan de l'entreprise, voir finRevenue pour plus de détails sur les variations de format. |
finReportingType | chaîne de caractères | Type de rapport si l'entreprise publie des rapports |
finReportingTypeText | chaîne de caractères | Type de rapport lisible par l'homme |
finReportingYear | nombre | Année de la dernière déclaration connue. |
L'objet contact
Il contient les données d'un seul contact / employé. Cet objet est disponible dans les requêtes "sync contact" et "sync lead".
id | chaîne de caractères | id Dealfront du contact |
salutation | chaîne de caractères | Salutation, par exemple "Monsieur". |
gender | homme | femme | Similaire à la salutation mais non traduit |
firstName | chaîne de caractères | Prénom |
lastName | chaîne de caractères | Nom de famille |
jobTitle | chaîne de caractères | Titre du poste tel qu'il a été trouvé pour ce contact. La langue est généralement la langue parlée par ce contact ou l'anglais. |
jobTitleEn | chaîne de caractères | Intitulé du poste en anglais, traduction de jobTitle. |
departments | objet | Le(s) département(s) de ce contact. Dans le format structuré, il s'agit d'un objet dont la clé est un identifiant de département non traduit et la valeur est le nom du département dans la langue des données du webhook. Le format plat est simplifié et n'inclut que le département le plus pertinent comme propriétés de l'objet contact lui-même. (Voir l'exemple ci-dessus) |
hierarchies | objet | Hiérarchies pour ce contact. Au format structuré, il s'agit d'un objet dont la clé est un identifiant de hiérarchie non traduit et la valeur est le nom de la hiérarchie dans le langage de données du webhook. Le format plat est simplifié et n'inclut que la hiérarchie la plus pertinente comme propriétés de l'objet contact lui-même. (Voir l'exemple ci-dessus) |
country | chaîne de caractères | Nom du pays |
countryCode | chaîne de caractères | Code pays ISO |
phone, phoneDirect, mobile | chaîne de caractères | Numéros de téléphone des contacts, y compris le numéro direct et le numéro de téléphone mobile s'il est connu. |
chaîne de caractères | Adresse électronique du contact telle que trouvée sur le web ou dans d'autres sources de données ou calculée sur la base d'autres contacts de la même entreprise. | |
emailStatusKey | chaîne de caractères | Si cet email a été vu dans les sources de données ou s'il a été calculé. |
emailStatusText | chaîne de caractères | Résumé lisible par l'homme de emailStatusKey et emailValidationStatusKey dans le langage de données du webhook. |
emailValidationStatusKey | valide | Résultat de la vérification de la validation de l'email |
socialProfiles |
| Profils sociaux. Dans le format structuré, il s'agit d'un objet dont la clé est la clé du réseau social et la valeur est une liste d'url de profil de ce contact. Dans le format plat, il est simplifié en propriétés sur l'objet principal du contact et il inclut seulement le profil le plus pertinent. |
companyId | chaîne de caractères | Identifiant de la société Dealfront. Il est égal à la propriété id de l'objet compagnie. Les requêtes incluent toujours l'objet société complet. |
L'objet méta
Il contient des informations supplémentaires non liées à la société et aux contacts.
customId | chaîne de caractères | Un identifiant que vous pouvez transmettre lorsque vous utilisez le webhook à partir d'une intégration CRM basée sur une iframe comme référence à la vue CRM actuelle. |
userId | chaîne de caractères | L'adresse e-mail de l'utilisateur Dealfront qui a déclenché la demande. |
--
Des questions, des commentaires, un retour d'expérience ? N'hésitez pas à nous en faire part en contactant notre équipe d'assistance par chat en direct ou en nous envoyant un E-mail à l'adresse suivante support@dealfront.com.