Webhooks Prokeep : Connectez vos données en temps réel

Aperçu

Les Webhooks Prokeep vous permettent d’envoyer des données d’événements en temps réel de Prokeep vers vos propres systèmes. Lorsque des activités clés se produisent dans votre compte — comme l’envoi ou la réception de messages, la création ou la fermeture de fils de discussion, ou encore la mise à jour de contacts et d’entreprises — Prokeep peut en informer vos systèmes immédiatement.

Utilisez les webhooks pour :

Enregistrer l’activité des SMS et des messages dans votre CRM ou ERP
Créer des tableaux de bord ou des classements dans vos outils BI
Déclencher des alertes et automatisations internes lors de nouveaux événements
Les combiner avec les API Prokeep pour synchroniser les contacts et les entreprises

Il n’existe aucune API de données historiques pour ces événements. Pour conserver un historique, créez des webhooks et enregistrez les données dans vos systèmes.

Pour les détails de sécurité et de configuration, consultez la documentation des Webhooks Prokeep.

Configuration des webhooks

Créez un webhook à l’aide d’une requête POST vers l’API REST.

Endpoint

POST https://{subdomain}.prokeep.com/rest/v1/webhooks

Exemple de requête

{
  "target_url": "https://your-endpoint.example.com/webhooks/prokeep",
  "events": {
    "message_received": true,
    "message_sent": true,
    "thread_created": true,
    "thread_claimed": true,
    "thread_closed": true,
    "company_created": true,
    "company_updated": true,
    "company_deleted": true,
    "contact_created": true,
    "contact_updated": true,
    "contact_deleted": true
  }
}

Exemple de réponse

{
  "data": {
    "id": "42061462-59ed-422d-a2b5-eb54170c288c",
    "url": "https://your-endpoint.example.com/webhooks/prokeep",
    "account_id": "0180c047-5566-4cc8-bccc-23ee53f61395",
    "inserted_at": "2025-05-08T18:51:56.628936Z",
    "updated_at": "2025-11-03T16:49:28.825594Z",
    "event_message_received": true,
    "event_message_sent": true,
    "event_thread_created": true,
    "event_thread_claimed": true,
    "event_thread_closed": true,
    "event_company_created": true,
    "event_company_updated": true,
    "event_company_deleted": true,
    "event_contact_created": true,
    "event_contact_updated": true,
    "event_contact_deleted": true
  }
}

Voir les webhooks existants

Lister tous les webhooks
- GET https://{subdomain}.prokeep.com/rest/v1/webhooks
Récupérer un webhook spécifique
- GET https://{subdomain}.prokeep.com/rest/v1/webhooks/{id}
Chaque webhook contient votre URL cible et les indicateurs d’événement configurés.

Cas d’utilisation et modèles

Tableaux de bord analytiques
- Enregistrez les événements des webhooks dans une base de données et alimentez votre outil BI pour suivre les volumes, les délais de réponse et les taux de clôture.
Journalisation dans le CRM et l’ERP
- Ajoutez l’historique des messages aux fiches clients et gardez les entreprises et contacts synchronisés en utilisant les webhooks combinés aux API Prokeep.
Alertes et automatisations
- Déclenchez des alertes pour les nouveaux fils de discussion, redirigez automatiquement les messages prioritaires ou planifiez des suivis.

Exemples de charge utile d’événements

Les exemples ci-dessous montrent des charges utiles typiques. Les valeurs de champs sont illustratives et utilisent des données fictives cohérentes pour les personnes et entreprises.
Les horodatages sont au format UTC ISO 8601.
specversion est toujours 1.0.

Message reçu

{
  "data": {
    "id": "019a4a9a-a87c-7363-b1b4-c9804bf499b4",
    "status": "received",
    "text": "Hi, can you quote two heavy duty widgets for pickup today?",
    "thread_id": "019a4a9a-a876-7e5c-ae78-b028d15e29b2"
  },
  "id": "374f8816-725a-413c-96be-1d83eea02fa0",
  "type": "message_received",
  "source": "https://prokeep.com",
  "event": "message_received",
  "specversion": "1.0"
}

Message envoyé

{
  "data": {
    "id": "019a4a9c-c3f3-777b-ae01-5c8c8ee985c5",
    "status": "sent",
    "text": "We have two in stock. I can set them aside for pickup today.",
    "inserted_by_contact": {
      "first_name": "Alex",
      "last_name": "Parker",
      "email_address": "alex.parker@example.com",
      "phone_number": "5551234567",
      "job_title": "Operations Manager"
    },
    "thread_id": "019a4a9a-a876-7e5c-ae78-b028d15e29b2"
  },
  "id": "46769e79-b8cd-4454-adef-9a5e6ef5c212",
  "type": "message_sent",
  "source": "https://prokeep.com",
  "event": "message_sent",
  "specversion": "1.0"
}

Fil de discussion créé

{
  "data": {
    "id": "019a4a9a-a876-7e5c-ae78-b028d15e29b2",
    "external_contact_id": "6fc1e09b-3fe0-4990-9a72-5b2be38ed5e1",
    "type": "sms",
    "inserted_at": "2025-11-03T16:44:01.005482Z"
  },
  "type": "thread_created",
  "source": "https://prokeep.com",
  "event": "thread_created",
  "specversion": "1.0"
}

Fil de discussion attribué

{
  "data": {
    "id": "019a4a9a-a876-7e5c-ae78-b028d15e29b2",
    "owner_contact_id": "a66d1ef8-ea3c-4288-812f-11db5a032eca",
    "updated_at": "2025-11-03T16:45:14.979284Z"
  },
  "type": "thread_claimed",
  "source": "https://prokeep.com",
  "event": "thread_claimed",
  "specversion": "1.0"
}

Fil de discussion fermé

{
  "data": {
    "id": "019a4a9a-a876-7e5c-ae78-b028d15e29b2",
    "owner_contact_id": "a66d1ef8-ea3c-4288-812f-11db5a032eca",
    "updated_at": "2025-11-03T16:47:35.569079Z"
  },
  "type": "thread_closed",
  "source": "https://prokeep.com",
  "event": "thread_closed",
  "specversion": "1.0"
}

Entreprise créée

{
  "data": {
    "id": "9cf0228a-3031-46eb-8c20-7ca0278c24c3",
    "name": "Northwind Supply",
    "email_address": "info@northwind.com",
    "phone_number": "5559876543",
    "inserted_at": "2025-11-03T16:50:50.933614Z"
  },
  "type": "company_created",
  "source": "https://prokeep.com",
  "event": "company_created",
  "specversion": "1.0"
}

Entreprise mise à jour

{
  "data": {
    "id": "9cf0228a-3031-46eb-8c20-7ca0278c24c3",
    "name": "Northwind Supply Co.",
    "email_address": "support@northwind.com",
    "phone_number": "5559876543",
    "updated_at": "2025-11-03T16:52:10.120000Z"
  },
  "type": "company_updated",
  "source": "https://prokeep.com",
  "event": "company_updated",
  "specversion": "1.0"
}

Entreprise supprimée


{
  "data": {
    "id": "9cf0228a-3031-46eb-8c20-7ca0278c24c3",
    "name": "Northwind Supply",
    "external_id": "43710729127"
  },
  "type": "company_deleted",
  "source": "https://prokeep.com",
  "event": "company_deleted",
  "specversion": "1.0"
}

Contact créé

{
  "data": {
    "id": "12eac27c-83f7-4170-800c-8c2f2dd13d7c",
    "first_name": "Alex",
    "last_name": "Parker",
    "email_address": "alex.parker@example.com",
    "phone_number": "5551234567",
    "job_title": "Operations Manager"
  },
  "type": "contact_created",
  "source": "https://prokeep.com",
  "event": "contact_created",
  "specversion": "1.0"
}

Contact mis à jour


{
  "data": {
    "id": "6fc1e09b-3fe0-4990-9a72-5b2be38ed5e1",
    "first_name": "Alex",
    "last_name": "Parker",
    "email_address": "alex.parker@example.com",
    "phone_number": "5551234567",
    "job_title": "Operations Manager"
  },
  "type": "contact_updated",
  "source": "https://prokeep.com",
  "event": "contact_updated",
  "specversion": "1.0"
}

Contact supprimé

{
  "data": {
    "id": "6fc1e09b-3fe0-4990-9a72-5b2be38ed5e1",
    "first_name": "Alex",
    "last_name": "Parker",
    "email_address": "alex.parker@example.com",
    "phone_number": "5551234567"
  },
  "type": "contact_deleted",
  "source": "https://prokeep.com",
  "event": "contact_deleted",
  "specversion": "1.0"
}

Notes

Les événements sont envoyés sous forme de requêtes HTTPS POST à votre point de terminaison configuré.
Les horodatages sont au format UTC ISO 8601.
specversion est 1.0 pour tous les événements.

Pour les détails d’authentification, d’en-têtes et de schéma, consultez la documentation des Webhooks Prokeep.