Emailing
beehiiv dans votre produit et vos agents IA, via une API
Le toolkit beehiiv couvre les publications, les abonnements, les tags d'abonnement, les posts et les statistiques agrégées des posts. Votre client se connecte une fois avec une API key, et votre produit ou agent IA appelle chaque opération via Connect, qui stocke l'identifiant et journalise chaque exécution.
15 jours d'essai. Sans carte bancaire.
POST https://connect.reportei.com/api/tools/beehiiv_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"publicationId": "<publicationId>",
"email": "<email>"
}
}Fonctionnement
Du client connecté au premier appel à beehiiv.
- 1
Votre client connecte son compte
Votre système ouvre une session Connect pour le toolkit et votre client connecte son compte beehiiv. Vous recevez l'id de la connexion.
- 2
Votre produit appelle la tool
Un POST sur /api/tools/{tool}/execute avec l'id de la connexion et les arguments. En cas de succès, Connect conserve le statut et le corps de la réponse de l'app.
- 3
Connect s'occupe du reste
Il stocke l'identifiant chiffré, renouvelle les tokens des connexions OAuth qui le permettent et enregistre les exécutions dans un journal d'audit consultable via l'API.
Cas d'usage
Ce que votre produit fait avec beehiiv.
Synchroniser les inscriptions
Quand un utilisateur s'inscrit dans votre SaaS, créez l'abonnement dans la publication du client et ajoutez un tag avec le plan ou la source.
Publier depuis votre produit
Créez un post à partir de HTML en brouillon ou planifié, pour qu'un outil de contenu envoie des newsletters vers beehiiv sans intégration dédiée.
Rapports de newsletter pour agents
Laissez un agent IA lister les posts et lire des statistiques agrégées, comme les ouvertures, les clics et les liens les plus cliqués, pour résumer la performance d'une publication.
Tools
12 tools beehiiv
- Lister les publicationsGETListe les publications accessibles avec la API key, avec id, name et organization_name. expand stats ajoute les abonnements actifs, les taux moyens d'ouverture et de clic et les totaux envoyés. Paginez avec page et limit, jusqu'à 100 ; la réponse contient total_pages.
- Lister les abonnementsGETListe les abonnements (abonnés) d'une publication, éventuellement pour un seul email, statut ou tier. Paginez avec limit, jusqu'à 100, et cursor : la réponse contient has_more et next_cursor.
- Obtenir un abonnementGETRenvoie un abonnement avec email, status, created, subscription_tier, les champs utm et referral_code.
- Créer un abonnementPOSTAbonne un email à une publication et renvoie l'abonnement avec son id. Avec le double opt-in sur la publication, ou double_opt_override activé, la personne confirme par email avant de devenir active.
- Mettre à jour un abonnementPATCHMet à jour un abonnement. Seuls les champs envoyés changent. unsubscribe true désabonne la personne de la publication.
- Créer un tag d'abonnementPOSTAjoute des tags à un abonnement. Un tag qui n'existe pas encore dans la publication est créé.
- Lister les postsGETListe les posts d'une publication avec id, title, subtitle, status, publish_date et web_url. expand stats ajoute les statistiques email et web de chaque post. Paginez avec page et limit, jusqu'à 100 ; la réponse contient total_pages.
- Obtenir un postGETRenvoie un post ; expand stats ajoute ses statistiques email et web. Un post créé à l'instant peut répondre 202 pendant que beehiiv le construit, et 404 avec POST_CREATION_FAILED quand la création a échoué.
- Créer un postPOSTCrée un post à partir de HTML et renvoie son id ; uniquement sur les plans Pro et Enterprise. status draft, la valeur par défaut, l'enregistre seulement ; confirmed l'envoie et le publie tout de suite ou à scheduled_at. beehiiv construit le post en arrière-plan, donc Get post peut répondre 202 un instant.
- Mettre à jour un postPATCHMet à jour un post ; uniquement sur les plans Pro et Enterprise. Seuls les champs envoyés changent, et body_content remplace tout le contenu. scheduled_at ne peut plus changer une fois le post envoyé.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
Questions sur le toolkit beehiiv
Dois-je intégrer l'API beehiiv moi-même ?
Non. Connect fournit 12 tools beehiiv décrites et prêtes. Votre client connecte son compte et votre système appelle chaque tool par le même endpoint, avec le même format de requête.
Comment mon client connecte-t-il son compte beehiiv ?
Avec le mode accepté par le toolkit : Clé d'API. Connect stocke l'identifiant chiffré et ne le renvoie jamais à votre système.
Est-ce compatible avec les agents IA ?
Oui. L'input de chaque tool est décrit en JSON Schema, que votre agent utilise directement comme définition de tool. L'agent choisit la tool et les arguments, et votre système fait l'appel à Connect.
Mon client doit-il avoir un compte Reportei ?
Non. Votre client connecte son compte sur un écran de Connect, ou votre système envoie l'identifiant via l'API, et il continue d'utiliser uniquement votre produit.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
