Développer

Webhooks entrants

Publiez des messages sans connexion persistante grâce à une URL secrète limitée à un salon.

Quand utiliser un webhook

Utilisez un webhook entrant pour les notifications de build, les alertes de supervision et la publication à sens unique. Créer, lister, supprimer ou renouveler un webhook exige MANAGE_WEBHOOKS ou la propriété de la communauté.

Créer un webhook

bash
curl -X POST https://beta.lyra.social/api/v1/guilds/$GUILD_ID/webhooks \
  -H "Authorization: Bearer $LYRA_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Deployments","channel_id":"<channel_id>"}'

Traitez cette URL comme un secret

Le jeton du webhook autorise la publication. Effectuez une rotation depuis les paramètres de la communauté s’il est exposé.

Exécuter un webhook

Le contenu doit comprendre entre 1 et 2 000 caractères. username peut remplacer le nom d’auteur affiché. Chaque webhook est limité à 30 messages par minute, en plus de la limite globale par IP.

bash
curl -X POST https://beta.lyra.social/api/v1/webhooks/$WEBHOOK_ID/$WEBHOOK_TOKEN \
  -H "Content-Type: application/json" \
  -d '{"content":"Build 184 deployed successfully","username":"CI"}'

Endpoints de gestion

MéthodeCheminAuthentification
GET/guilds/:guild_id/webhooksBearer + MANAGE_WEBHOOKS
POST/guilds/:guild_id/webhooksBearer + MANAGE_WEBHOOKS
DELETE/guilds/:guild_id/webhooks/:webhook_idBearer + MANAGE_WEBHOOKS
POST/guilds/:guild_id/webhooks/:webhook_id/reset-tokenBearer + MANAGE_WEBHOOKS
PATCH/webhooks/:webhook_id/:tokenJeton du webhook
DELETE/webhooks/:webhook_id/:tokenJeton du webhook
POST/webhooks/:webhook_id/:tokenJeton du webhook