Annuler Confirmer

Webhook

1. Information

Une URL de webhook est l'adresse HTTPS que notre serveur appellera pour chaque événement au fur et à mesure qu'il se produit.
Il doit retourner un 200 OK code HTTPS si tout se passe bien. Tout autre code HTTPS ne sera pas pris en compte

Pour des raisons de sécurité, nous vous recommandons d'intégrer une authentification de base pour vous assurer que les données ne peuvent pas être interceptées et que seuls nos serveurs peuvent vous envoyer des données : https://username:password@example.com/scorimmo_triggers.php

De plus nous permettons l’ajout d’une clé/valeur personnalisé dans le header que nous transmettrons sur l’ensemble des requêtes.

Les données d'événement sont envoyées dans le POST corps de la requête à l'aide d'un objet JSON. Son contenu dépend de l'événement et des informations complétés.

2. Type d'événement

2.1. Événement new_lead

Envoyé lors de la création d’un nouveau lead hors action API

L'objet JSON contient les propriétés suivantes :

id : Numéro Scorimmo du lead
residence_type : Type de résidence (ne s’affiche que si le champ est renseigné) (valeur possible : INVESTMENT, PRINCIPAL, SECONDARY)
funding_type : Financement (ne s’affiche que si le champ est renseigné) (valeur possible : CASH, GOT, IN_PROGRESS, NOT_STUDIED)
have_residence_to_sell : A un bien à vendre (ne s’affiche que si le champ est ‘true’) (valeur possible : true)
has_lot : Possession terrain (ne s’affiche que si le champ est ‘true’) (valeur possible : true)
custom_fields : Object avec les demandes personnalisées du lead non nulles. Si le champ est de type booléen, la valeur ne pourra pas être null et sera donc envoyée systématiquement (valeur : true, false)
- exemple 1 : Test
- exemple 2 : true
- exemple 3 : false
seller : Object avec les informations sur l’utilisateur en charge du lead
- id : Numéro Scorimmo
- first_name : Prénom
- last_name : Nom
- email : Email
customer : Object avec les informations sur le prospect
- title : Titre (valeur possible : M., Mme)
- first_name : Prénom (ne s’affiche que si le champ est renseigné)
- last_name : Nom
- email : Email (ne s’affiche que si le champ est renseigné)
- phone : Téléphone (ne s’affiche que si le champ est renseigné)
- other_phone_number : Numéro secondaire du prospect (ne s’affiche que si le champ est renseigné)
- zip_code : Code postal du prospect (ne s’affiche que si le champ est renseigné)
- city : Ville du prospect (ne s’affiche que si le champ est renseigné)
properties : Tableau d'objets avec les informations sur les propriétés
- id : Numéro Scorimmo
- type : Type (ne s’affiche que si le champ est renseigné)
- price : Prix (ne s’affiche que si le champ est renseigné)
- area : Surface (ne s’affiche que si le champ est renseigné)
- nb_rooms : Nombre de pièces (ne s’affiche que si le champ est renseigné)
- reference : Référence (ne s’affiche que si le champ est renseigné)
- address : Ville + code postal (ne s’affiche que si l'un des champs est renseigné)
- link : Lien (ne s’affiche que si le champ est renseigné)
comments : Tableau d'objets avec les informations sur les commentaires (si aucun commentaire, valeur à null)
- content : Contenu
- created_at : Horodatage de création du commentaire (format : yyyy-MM-dd HH:mm:ss)
store_id : Point de vente du lead
origin : Origine (source) du lead
interest : Univers de création du lead
created_at : Horodatage de création du lead (format : yyyy-MM-dd HH:mm:ss)
status : Statut Scorimmo actuel du lead
purpose : Type de demande (valeur possible : Achat, Vente, Estimation, Location, Recherche, Locataire, Bailleur)
seller_present_on_creation : Commercial présent à la création du lead (valeur : true, false)
contact_type : Canal de communication (valeur : call, email, physical)
transfered : Transfert télécoms du lead au commercial (valeur : true, false)
external_lead_id : Numéro de lead externe (ne s’affiche que si le champ est renseigné)
external_customer_id : Numéro du client externe (ne s’affiche que si le champ est renseigné)
request : Type de demande administrative (ne s’affiche que si le champ est renseigné)
other_request : Type de demande administrative autre (ne s’affiche que si le champ est renseigné)
event : Type de webhook (valeur : new_lead)

Exemple d'événement envoyé :

{
    "id": 2,
    "seller": {
        "id": 2,
        "first_name": "Commercial",
        "last_name": "Scorimmo",
        "email": "vendeur@scorimmo.com"
    },
    "customer": {
        "title": "M.",
        "first_name": "Prenom_2",
        "last_name": "Nom_2",
        "email": "Email_2",
        "phone": "Phone_2"
    },
    "properties": [
    {
        "id": 1,
        "type": "Maison",
        "price": "368 259",
        "area": 100,
        "reference": "REF_6046",
        "address": "44000 NANTES",
        "link": "https://www.liendevotreannonce.com/1234"
    }
    ],
    "comments": [
    {
        "content": "Scorimmo a ajouté un commentaire : Le client souhaite signer demain",
        "created_at": "2025-01-01 00:00:39"
    }
    ],
    "origin": "Leboncoin",
    "interest": "TRANSACTION",
    "created_at": "2025-01-01 00:00:39",
    "status": "Affecté",
    "purpose": "Achat",
    "seller_present_on_creation": true,
    "contact_type": "call",
    "transfered": false,
    "event": "new_lead"
}

2.2. Événement update_lead

Envoyé lors de la modification d’un lead hors action API

L'objet JSON contient les propriétés suivantes :

id : Numéro Scorimmo du lead
updated_at : Horodatage de modification du lead (format : yyyy-MM-dd HH:mm:ss)
residence_type : Type de résidence (ne s’affiche que si le champ est modifié) (valeur possible : INVESTMENT, PRINCIPAL, SECONDARY)
funding_type : Financement (ne s’affiche que si le champ est modifié) (valeur possible : CASH, GOT, IN_PROGRESS, NOT_STUDIED)
have_residence_to_sell : A un bien à vendre (ne s’affiche que si le champ est modifié) (valeur possible : true)
has_lot : Possession terrain (ne s’affiche que si le champ est modifié) (valeur possible : true)
store_id : Point de vente du lead
custom_fields : Object avec les demandes personnalisées du lead (toutes les demandes non nulles sont renvoyées en cas de modification de l'une d'entre elles). Si le champ est de type booléen, la valeur ne pourra pas être null et sera donc envoyée systématiquement (valeur : true, false)
- exemple 1 : Test
- exemple 2 : true
- exemple 3 : false
seller : Object avec les informations sur l’utilisateur en charge du lead (ne s’affiche que si un des champs est modifié)
- id : Numéro Scorimmo (ne s’affiche que si le champ est modifié)
- first_name : Prénom (ne s’affiche que si le champ est modifié)
- last_name : Nom (ne s’affiche que si le champ est modifié)
- email : Email (ne s’affiche que si le champ est modifié)
customer : Object avec les informations sur le prospect (ne s’affiche que si un des champs est modifié)
- title : Titre (ne s’affiche que si le champ est modifié) (valeur possible : M., Mme)
- first_name : Prénom (ne s’affiche que si le champ est modifié)
- last_name : Nom (ne s’affiche que si le champ est modifié)
- email : Email (ne s’affiche que si le champ est modifié)
- phone : Téléphone (ne s’affiche que si le champ est modifié)
- other_phone_number : Numéro secondaire du prospect (ne s’affiche que si le champ est modifié)
- zip_code : Code postal du prospect (ne s’affiche que si le champ est modifié)
- city : Ville du prospect (ne s’affiche que si le champ est modifié)
properties : Tableau d'objets avec les informations sur les propriétés (ne s’affiche que si un des champs est modifié)
- id : Numéro Scorimmo (ne s’affiche que si un des champs est modifié)
- type : Type (ne s’affiche que si le champ est modifié)
- price : Prix (ne s’affiche que si le champ est modifié)
- area : Surface (ne s’affiche que si le champ est modifié)
- nb_rooms : Nombre de pièces (ne s’affiche que si le champ est renseigné)
- reference : Référence (ne s’affiche que si le champ est modifié)
- address : Ville + code postal (ne s’affiche que si un des champs est modifié)
- link : Lien (ne s’affiche que si le champ est modifié)
purpose : Type de demande (ne s’affiche que si le champ est modifié) (valeur possible : Achat, Vente, Estimation, Location, Recherche, Locataire, Bailleur)
request : Type de demande administrative (ne s’affiche que si le champ est modifié)
other_request : Type de demande administrative autre (ne s’affiche que si le champ est modifié)
event : Type de webhook (valeur : update_lead)

Exemple d'événement envoyé :

{
    "id": 2,
    "updated_at": "2025-01-01 00:00:39",
    "customer": {
        "first_name": "Prenom_3",
    },
    "event": "update_lead"
}

2.3. Événement new_comment

Envoyé lors de la création d’un nouveau commentaire hors action API

L'objet JSON contient les propriétés suivantes :

event : Type de webhook (valeur : new_comment)
lead_id : Numéro Scorimmo du lead
external_lead_id : Numéro de lead externe (ne s’affiche que si le champ est renseigné)
comment : Contenu du commentaire
created_at : Horodatage de création du commentaire (format : yyyy-MM-dd HH:mm:ss)

Exemple d'événement envoyé :

{
    "event": "new_comment",
    "lead_id": 2,
    "comment": "3eme appel du client",
    "created_at": "2025-01-01 00:00:39"
}

2.4. Événement new_reminder

Envoyé lors de la création d’un nouveau rappel hors action API

L'objet JSON contient les propriétés suivantes :

event : Type de webhook (valeur : new_reminder)
lead_id : Numéro Scorimmo du lead
external_lead_id : Numéro de lead externe (ne s’affiche que si le champ est renseigné)
created_at : Horodatage de création du rappel (format : yyyy-MM-dd HH:mm:ss)
start_time : Horodatage du rappel (format : yyyy-MM-dd HH:mm:ss)
detail : Type de rappel (valeur possible : offer, recontact)
comment : Contenu du commentaire

Exemple d'événement envoyé :

{
    "event": "new_reminder",
    "lead_id": 2,
    "external_lead_id": null,
    "created_at": "2025-01-01 00:00:39",
    "start_time": "2025-01-02 09:00:00",
    "detail": "recontact",
    "comment": "Retour de la banque ce jour"
}

2.5. Événement new_rdv

Envoyé lors de la création d’un nouveau rendez-vous hors action API

L'objet JSON contient les propriétés suivantes :

event : Type de webhook (valeur : new_rdv)
lead_id : Numéro Scorimmo du lead
external_lead_id : Numéro de lead externe (ne s’affiche que si le champ est renseigné)
created_at : Horodatage de création du rendez-vous (format : yyyy-MM-dd HH:mm:ss)
start_time : Horodatage du rendez-vous (format : yyyy-MM-dd HH:mm:ss)
location : Lieu renseigné du rendez-vous
detail : Type de rendez-vous (valeur possible : null, Estimation, Découverte, Visite, Suivi, Proposition, Signature)
comment : Contenu du commentaire

Exemple d'événement envoyé :

{
    "event": "new_rdv",
    "lead_id": 2,
    "created_at": "2025-01-01 00:00:39",
    "start_time": "2025-01-02 09:00:00",
    "location": "Agence Scorimmo 64 Rue du Abysses, Les Sables",
    "detail": null,
    "comment": null
}

2.6. Événement closure_lead

Envoyé lors de la fermeture du lead hors action API

L'objet JSON contient les propriétés suivantes :

event : Type de webhook (valeur : closure_lead)
lead_id : Numéro Scorimmo du lead
external_lead_id : Numéro de lead externe (ne s’affiche que si le champ est renseigné)
status : Statut du lead (valeur possible : SUCCESS, CLOSED, CLOSE_OPERATOR)
close_reason : Raison de clôture (ne s’affiche que si le status est en CLOSED ou SUCCESS)

Exemple d'événement envoyé :

{
    "event": "closure_lead",
    "lead_id": 2,
    "status": "SUCCESS",
}