SendGrid

  # Intégration de SendGrid 

## Aperçu

sendgrid est une intégration qui permet à un chatbot Botpress d'envoyer des emails via l'API SendGrid .

## Configuration

### Authentification de votre domainesendgrid

1. Se connecter au tableau de bord de SendGrid sendgrid
2. Dans la barre de navigation à gauche, ouvrez le sous-menu "Paramètres", cliquez sur "Authentification de l'expéditeur"
3. Dans la partie centrale droite de l'écran, cliquez sur le bouton "Get Started" (First domain authentication only)
   - (authentification du 2ème domaine et plus) Dans la partie inférieure gauche de la section "Authentification du domaine", cliquez sur "Authentifier votre domaine".
4. Sélectionnez le fournisseur de votre domaine, si le fournisseur n'est pas listé, choisissez "I'm Not Sure" (C'est plus facile que l'option "Other host")
   - Testé également avec SquareSpace Domains
5. Dans le champ "From Domain", entrez votre domaine (par exempleBotpress.com")
6. Ajoutez les enregistrements DNS dans le portail de votre fournisseur de domaine (par exemple Cloudflare, GoDaddy, SquareSpace, etc.)
7. Cochez "I've added these records" et cliquez sur "Verify" et attendez que SendGrid confirme la vérification.
   - Si une erreur est toujours affichée malgré l'ajout correct des enregistrements DNS 'CNAME' à votre fournisseur de domaine, essayez de supprimer le suffixe du domaine de la clé d'hôte. (par exemple, "em1234botpress.com" > "em1234").
8. Vous êtes maintenant prêt à envoyer des emails avec votre domaine. Bon envoi d'emails !

### Acquisition d'une clé APIsendgrid

1. Connectez-vous au tableau de bord de SendGrid sendgrid
2. Dans la barre de navigation à gauche, ouvrez le sous-menu "Settings", cliquez sur "API Keys"
3. En haut à droite, cliquez sur "Create API Key" (Créer une clé API)
4. Donnez un nom à la clé
5. Accordez des autorisations à la clé, soit avec un "accès complet", soit avec un "accès restreint", en sélectionnant les éléments suivants :
   - "Envoi de courrier" (accès complet)
6. Cliquez sur "Créer et visualiser"

### Configuration des Webhookswebhook

1. Connectez-vous au tableau de bord de SendGrid sendgrid
2. Dans la barre de navigation à gauche, ouvrez le sous-menu "Settings", cliquez sur "Mail Settings"
3. Dans "Mail Settings", cliquez sur "Event Webhooks"
4. Dans la partie centrale droite de l'écran, cliquez sur "Create new webhook" (Créer un nouveau webhook)
5. (Facultatif) Donnez au webhook un "Friendly Name" (e.g.Botpress Bot")
6. Copiez l'URL du webhook depuis la configuration de l'intégration Botpress et collez-la dans le champ "Post URL" de Sendgrid.
7. Sélectionnez les "Actions à poster", ce seront les événements que l'intégration Botpress recevra.
   1. Note : Cette intégration ne supporte pas encore tous les événements.
8. (Optionnel, mais recommandé) Activez la "Vérification de la signature"
   1. Si vous l'avez activé, une fois que le webhook est sauvegardé, cliquez sur le rouage du webhook et cliquez sur "modifier"
   2. Copiez la "Verification key" de Sendgrid et collez-la dans le champWebhook Verification Key" de la configuration de l'intégration Botpress 
9. Cliquez sur "Enregistrer" et vous êtes prêt à utiliser les événements dans votre bot Botpress 

## Notes annexes

L'implémentation actuelle est limitée à l'envoi d'emails en texte enrichi [markdown](https://spec.commonmark.org/0.31.2/), mais cela sera étendu dans le futur.

## Ressources

- https://www.twilio.com/docs/sendgrid/for-developers
- https://www.twilio.com/docs/sendgrid/api-reference
- https://www.twilio.com/docs/sendgrid/ui/account-and-settings/api-keys
- https://www.twilio.com/docs/sendgrid/ui/account-and-settings/how-to-set-up-domain-authentication