Exporter les données des réunions avec des webhooks
Utilisez l’intégration webhook pour exporter les données des réunions et créer des intégrations personnalisées
Après chaque réunion correspondante, les webhooks Circleback envoient une requête POST avec un corps JSON à l’URL HTTPS publique de votre choix. Chaque requête est signée avec un en-tête X-Signature contenant un condensé HMAC-SHA256, ce qui vous permet de vérifier qu’elle provient de Circleback. Utilisez-les pour exporter les données de vos réunions et créer des intégrations personnalisées.
Configuration
- Ouvrez Automatisations et sélectionnez Nouvelle automatisation.
- Ajoutez des conditions d’automatisation pour limiter les réunions après lesquelles l’automatisation s’exécute, puis sélectionnez Suivant.
- Sélectionnez Envoyer une requête webhook.
- Saisissez l’URL du point de terminaison auquel vous souhaitez envoyer les requêtes webhook ainsi que les résultats de réunion que vous souhaitez inclure.
- Vous pouvez également envoyer une requête de test pour la réunion la plus récente afin de vérifier que tout fonctionne.
- Sélectionnez Terminé.
- Donnez un nom à votre automatisation en haut de la page et sélectionnez Enregistrer.
Désormais, chaque réunion qui correspond à vos conditions d’automatisation sera envoyée à votre point de terminaison webhook.
Vous pouvez exporter vos réunions passées en sélectionnant toutes les réunions et en choisissant votre nouvelle automatisation dans le menu Actions.
Requêtes
Une fois la configuration terminée, vous commencerez à recevoir des requêtes POST à l’URL du point de terminaison indiquée, avec un corps JSON qui comprend les champs suivants :
id(chaîne) : identifiant de la réunion Circleback, utilisable pour générer un lien vers la réunion sur Circleback (https://circleback.ai/meetings/${id})name(chaîne) : nom de la réunioncreatedAt(chaîne) : date de création de la réunion au format de chaîne ISOduration(nombre) : durée de la réunion en secondesurl(chaîne ou null) : URL de la réunion virtuelle (p. ex. Zoom, Google Meet, Microsoft Teams)recordingUrl(chaîne ou null) : URL du fichier d’enregistrement de la réunion, valable seulement 24 heures (disponible uniquement si l’enregistrement des réunions est activé dans les paramètres)tags(tableau de chaînes) : noms des tags ajoutés à la réunionicalUid(chaîne ou null) : identifiant unique de l’événement d’agenda associé à la réunionattendees(tableau d’objets) : invités de la réunionname(chaîne ou null) : nom de l’invité de l’événement d’agenda si la réunion est associée à un événement d’agenda, ou nom du participant à la réunionemail(chaîne ou null) : adresse e-mail de l’invité de l’événement d’agenda si la réunion est associée à un événement d’agenda
notes(chaîne) : notes de réunion Circleback au format MarkdownactionItems(tableau d’objets) : tableau des actions à mener créées pour la réunionid(nombre) : identifiant Circleback de l’action à menertitle(chaîne) : titre de l’action à menerdescription(chaîne) : description de l’action à menerassignee(objet ou null) : objet représentant la personne assignée à l’action à mener, ou null si elle n’est pas assignéename(chaîne ou null) : nom de la personne assignéeemail(chaîne ou null) : adresse e-mail de la personne assignée
status(chaîne) : statut de l’action à mener, « PENDING » ou « DONE »
transcript(tableau d’objets) : segments de la transcription de la réunionspeaker(chaîne) : nom de l’intervenanttext(chaîne) : paroles prononcéestimestamp(nombre) : horodatage en secondes qui marque le début du segment
insights(objet) :[insightName](clé d’objet de type chaîne) : nom de l’insight créé par l’utilisateur- tableau d’objets
insight(chaîne, ou objet si l’insight comporte des champs personnalisés) : le résultat de l’insightspeaker(chaîne ou null) : intervenant auquel l’insight est associé (le cas échéant)timestamp(nombre ou null) : l’horodatage en secondes auquel l’insight est associé (le cas échéant)
- tableau d’objets
Exemple
{
"id": "WRweb12iCBimU6Vo8cD7z",
"name": "Event Venue Review",
"createdAt": "2023-07-25T20:30:57.926Z",
"duration": 1306.09,
"url": "https://meet.google.com/abc-defgh-xyz",
"recordingUrl": null,
"tags": ["Events"],
"icalUid": "1a2b3c@google.com",
"attendees": [
{ "name": "John Appleseed", "email": "john@example.com" },
{ "name": "Samantha Grey", "email": "sam@example.com" }
],
"notes": "#### Overview\n* Several options for event venues were reviewed...",
"actionItems": [
{
"id": 252,
"title": "Contact event venues",
"description": "Reach out to Sunriver Events and other potential event venues to see if they would be open to hosting the event this summer.",
"assignee": {
"name": "John Appleseed",
"email": "john@example.com"
},
"status": "PENDING"
},
{
"id": 253,
"title": "Review and finalize venue options",
"description": "Review pricing and availability of venues and pick a venue for the event.",
"assignee": null,
"status": "PENDING"
}
],
"transcript": [
{
"speaker": "John Appleseed",
"text": "Hey, how's it going?",
"timestamp": 4.56
},
{
"speaker": "Samantha Grey",
"text": "Going well, just testing webhooks in Circleback.",
"timestamp": 18.32
}
],
"insights": {
"Customer details": [
{
"insight": {
"Company name": "Initech",
"Number of employees": 120
},
"speaker": "John Appleseed",
"timestamp": 800
}
],
"Questions": [
{
"insight": "Is this thing on?",
"speaker": "Samantha Grey",
"timestamp": 49.15
},
{
"insight": "When will the webhook integration be ready?",
"speaker": "John Appleseed",
"timestamp": 120.12
}
]
}
}Vérifier les requêtes entrantes (facultatif)
Pour vous assurer que les événements webhook reçus proviennent de Circleback, vous pouvez vérifier les requêtes entrantes à l’aide d’un secret de signature. Cette étape est facultative, mais recommandée pour renforcer la sécurité.
Lorsque vous configurez le webhook dans une automatisation, un secret de signature vous est fourni. Ce secret de signature est une chaîne unique et sécurisée utilisée pour générer une signature cryptographique pour chaque événement webhook.
Pour vérifier la signature, procédez comme suit :
- Extrayez la signature des en-têtes de la requête entrante. La signature se trouve dans un en-tête nommé
x-signature. - Générez la signature attendue à l’aide du secret de signature et du corps de la requête.
- Comparez la signature attendue à la signature fournie. Si elles correspondent, la requête est considérée comme valide et vous pouvez traiter l’événement webhook.
Voici un exemple d’implémentation en TypeScript :
import { createHmac, timingSafeEqual } from 'crypto'
import express from 'express'
// Mount this on the webhook route so req.body stays the raw bytes.
// Do not use express.json() before verifying.
export const rawJsonBody = express.raw({ type: 'application/json' })
export const verifyWebhookSignature = (
requestBody: Buffer,
signature: string,
signingSecret: string
) => {
const expectedSignature = createHmac('sha256', signingSecret)
.update(requestBody)
.digest('hex')
const expected = Buffer.from(expectedSignature)
const provided = Buffer.from(signature)
return (
expected.length === provided.length &&
timingSafeEqual(expected, provided)
)
}
export const webhookEndpointHandler = async (
req: express.Request,
res: express.Response
) => {
try {
const requestBody = req.body
const signature = req.headers['x-signature']
const signingSecret = 'your-signing-secret'
if (
!Buffer.isBuffer(requestBody) ||
typeof signature !== 'string' ||
!verifyWebhookSignature(requestBody, signature, signingSecret)
) {
return res.status(401).json({ error: 'Invalid signature.' })
}
const payload = JSON.parse(requestBody.toString('utf8'))
await processWebhookEvent(payload)
return res.status(200).json({
message: 'Webhook event processed successfully.',
})
} catch (error) {
console.error('Error processing webhook event.', error)
return res.status(500).json({ error: 'Error processing webhook event.' })
}
}
app.post('/webhook', rawJsonBody, webhookEndpointHandler)Veillez à remplacer 'your-signing-secret' par le secret de signature réel fourni à l’étape webhook de l’automatisation.
En vérifiant la signature, vous vous assurez que les événements webhook que vous recevez proviennent de Circleback et n’ont pas été altérés. Cela contribue à protéger votre application contre les accès non autorisés et les attaques potentielles.
Nouvelles tentatives
Si votre point de terminaison renvoie une réponse autre que 2xx, rencontre une erreur ou ne répond pas dans un délai de 5 minutes, Circleback renvoie automatiquement la requête, jusqu’à 9 fois de plus. En raison de ces nouvelles tentatives, la même réunion peut arriver plusieurs fois : utilisez donc l’id de la réunion pour ignorer les doublons.