Événements¶

Chaque type d'événement qu'OS enregistre, ce dont il parle et ce que contiennent ses refs, ainsi que les limites du flux et des webhooks. GET /api/v1/event-kinds donne la même liste sous forme de données. Ce que sont les événements figure dans Événements et webhooks.

Types¶

Les refs d'un type ne font que grandir : un champ s'ajoute, aucun ne disparaît jamais et un champ ne change jamais de sens. Une modification qui casserait votre programme est un nouveau type, avec un nouveau nom.

Type	Quand	Concerne (`see` requis)	`refs`
`directory.invitation.created`	une invitation a été envoyée	`invitation`	`invitation_id`
`directory.invitation.accepted`	une invitation a été acceptée	`invitation`	`invitation_id`, `membership_id`
`directory.invitation.revoked`	une invitation a été retirée	`invitation`	`invitation_id`
`directory.invitation.expired`	une invitation a expiré	`invitation`	`invitation_id`
`directory.membership.created`	quelqu'un est devenu membre	`membership`	`membership_id`, `principal_kind`, `status`
`directory.membership.deactivated`, `.reactivated`, `.removed`	le statut d'une appartenance a changé	`membership`	`membership_id`, `principal_kind`, `status`
`access.role.assigned`, `access.role.unassigned`	un rôle a été donné à un membre ou à un groupe, ou retiré	`role`	`role_id`, `reach`, et `membership_id` ou `group_id`
`access.group.member_added`, `access.group.member_removed`	les membres d'un groupe ont changé	`group`	`group_id`, `membership_id`
`organisations.organisation.created`, `.erased`	une organisation sous la vôtre a été créée, ou sa suppression est terminée ; enregistré dans la vôtre	`organisation`	`organisation_id`
`organisations.organisation.suspended`, `.reactivated`	votre organisation a été suspendue ou rétablie	`organisation`	`organisation_id`, `status`
`organisation_settings.settings.changed`	les paramètres de votre organisation ont changé	`organisation`	`fields` : les noms des paramètres modifiés, jamais leurs valeurs
`service.plan.assigned`, `service.plan.removed`, `service.plan.lapsed`	le service de votre organisation a reçu une offre, en a perdu une, ou une offre a expiré	`service`	`plan_id`, et `ends_at` pour une période d'essai
`exports.export.completed`, `exports.export.failed`	un export de votre organisation ou d'un membre est prêt, ou a échoué	`export`	`export_id`, `scope`, `status`
`events.webhook.tested`	quelqu'un a envoyé un test à un webhook ; seulement à ce webhook, jamais dans le flux	`event`	`subscription_id`

Limites¶

Quoi	Limite
combien de temps OS conserve un événement et ses livraisons	7 jours
webhooks par organisation	20
une page du flux	100 événements au plus
livraisons d'un même webhook envoyées en même temps	4 ; 1 tant qu'il est défaillant
combien de temps OS attend votre réponse	10 secondes
tentatives par livraison	8, en environ 45 heures
échecs de suite avant qu'un webhook soit défaillant	5
défaillant avant qu'un webhook soit désactivé	3 jours
le chevauchement d'un secret après remplacement	0 à 168 heures, 24 par défaut
une adresse	`https`, un nom d'hôte, 2 048 caractères au plus, port 443

Artific peut fixer d'autres limites pour votre environnement.