yuno.chat

Référence de l’API

Points de terminaison des webhooks

Les points de terminaison des webhooks sont les URL auxquelles Yuno Chat envoie ses événements. Consultez le guide des webhooks pour les types d’événements, les données envoyées et la vérification des signatures. Disponibles avec Growth et Pro.

L’objet point de terminaison webhook

Attributs

  • idstring

    Identifiant unique, préfixé par whe_.

  • objectstring

    Toujours webhook_endpoint.

  • urlstring

    L’URL HTTPS à laquelle les événements sont envoyés.

  • eventsarray of strings

    Types d’événements à envoyer, ou ["*"] pour tous les recevoir.

  • enabledboolean

    Les points de terminaison désactivés ne reçoivent rien.

  • descriptionstring | null

    Une note pour votre équipe.

  • secretstring

    Le secret de signature, whsec_…. Renvoyé uniquement lors de la création du point de terminaison.

  • created_atstring

    Date de création de l’objet, au format ISO 8601 en UTC.

Objet point de terminaison webhook
{
  "id": "whe_3Lp9sDf6",
  "object": "webhook_endpoint",
  "url": "https://example.com/hooks/yuno",
  "events": [
    "ticket.created",
    "conversation.handed_off"
  ],
  "enabled": true,
  "description": "Alertes opérationnelles",
  "created_at": "2026-09-20T10:00:00Z"
}

Créer un point de terminaison webhook

POST/webhook-endpoints

Enregistre une URL. La réponse contient le secret de signature ; conservez-le, car il ne sera plus affiché.

Paramètres du corps

  • urlstringobligatoire

    Une URL HTTPS.

  • eventsarray of stringsobligatoire

    Types d’événements, ou ["*"].

  • descriptionstring

    Une note pour votre équipe.

Requête
curl -X POST https://api.yuno.chat/v1/webhook-endpoints \
  -H "Authorization: Bearer $YUNO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hooks/yuno",
    "events": [
      "ticket.created",
      "conversation.handed_off"
    ],
    "description": "Alertes opérationnelles"
  }'
Réponse · 201
{
  "id": "whe_3Lp9sDf6",
  "object": "webhook_endpoint",
  "url": "https://example.com/hooks/yuno",
  "events": [
    "ticket.created",
    "conversation.handed_off"
  ],
  "enabled": true,
  "description": "Alertes opérationnelles",
  "created_at": "2026-09-20T10:00:00Z",
  "secret": "whsec_Jk2v9QmL0pXr7sTn"
}

Lister les points de terminaison webhook

GET/webhook-endpoints

Renvoie tous les points de terminaison webhook.

Paramètres de requête

  • limitinteger

    Nombre d’objets à renvoyer, entre 1 et 100. Valeur par défaut : 20.

  • cursorstring

    Le next_cursor d’une page précédente. Omettez-le pour commencer par l’objet le plus récent.

Requête
curl https://api.yuno.chat/v1/webhook-endpoints \
  -H "Authorization: Bearer $YUNO_SECRET_KEY"
Réponse · 200
{
  "object": "list",
  "data": [
    {
      "id": "whe_3Lp9sDf6",
      "object": "webhook_endpoint",
      "url": "https://example.com/hooks/yuno",
      "events": [
        "ticket.created",
        "conversation.handed_off"
      ],
      "enabled": true,
      "description": "Alertes opérationnelles",
      "created_at": "2026-09-20T10:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Mettre à jour un point de terminaison webhook

PATCH/webhook-endpoints/{id}

Modifie l’URL ou les événements, ou désactive le point de terminaison.

Paramètres de chemin

  • idstringobligatoire

    L’identifiant du point de terminaison.

Paramètres du corps

  • urlstring

    Nouvelle URL.

  • eventsarray of strings

    Remplace la liste des événements.

  • enabledboolean

    Active ou désactive le point de terminaison.

  • descriptionstring

    Une note pour votre équipe.

Requête
curl -X PATCH https://api.yuno.chat/v1/webhook-endpoints/whe_3Lp9sDf6 \
  -H "Authorization: Bearer $YUNO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'
Réponse · 200
{
  "id": "whe_3Lp9sDf6",
  "object": "webhook_endpoint",
  "url": "https://example.com/hooks/yuno",
  "events": [
    "ticket.created",
    "conversation.handed_off"
  ],
  "enabled": false,
  "description": "Alertes opérationnelles",
  "created_at": "2026-09-20T10:00:00Z"
}

Envoyer un événement de test

POST/webhook-endpoints/{id}/test

Envoie un événement ping au point de terminaison et renvoie la réponse de votre serveur.

Paramètres de chemin

  • idstringobligatoire

    L’identifiant du point de terminaison.

Requête
curl -X POST https://api.yuno.chat/v1/webhook-endpoints/whe_3Lp9sDf6/test \
  -H "Authorization: Bearer $YUNO_SECRET_KEY"
Réponse · 200
{
  "delivered": true,
  "status_code": 200,
  "duration_ms": 182
}

Supprimer un point de terminaison webhook

DELETE/webhook-endpoints/{id}

Arrête l’envoi d’événements à cette URL.

Paramètres de chemin

  • idstringobligatoire

    L’identifiant du point de terminaison.

Requête
curl -X DELETE https://api.yuno.chat/v1/webhook-endpoints/whe_3Lp9sDf6 \
  -H "Authorization: Bearer $YUNO_SECRET_KEY"
Réponse · 200
{
  "id": "whe_3Lp9sDf6",
  "object": "webhook_endpoint",
  "deleted": true
}