Gebeurtenissen¶

Elke soort gebeurtenis die OS vastlegt, waar ze over gaat en wat haar refs bevatten, en de grenzen van de feed en van webhooks. GET /api/v1/event-kinds geeft dezelfde lijst als gegevens. Wat gebeurtenissen zijn, staat in Gebeurtenissen en webhooks.

Soorten¶

De refs van een soort groeien alleen: er komt een veld bij, er verdwijnt er nooit een en een veld krijgt nooit een andere betekenis. Een wijziging die je programma zou breken, is een nieuwe soort met een nieuwe naam.

Soort	Wanneer	Gaat over (`see` nodig)	`refs`
`directory.invitation.created`	een uitnodiging is verstuurd	`invitation`	`invitation_id`
`directory.invitation.accepted`	een uitnodiging is aangenomen	`invitation`	`invitation_id`, `membership_id`
`directory.invitation.revoked`	een uitnodiging is ingetrokken	`invitation`	`invitation_id`
`directory.invitation.expired`	een uitnodiging is verlopen	`invitation`	`invitation_id`
`directory.membership.created`	iemand is lid geworden	`membership`	`membership_id`, `principal_kind`, `status`
`directory.membership.deactivated`, `.reactivated`, `.removed`	de status van een lidmaatschap is veranderd	`membership`	`membership_id`, `principal_kind`, `status`
`access.role.assigned`, `access.role.unassigned`	een rol is aan een lid of groep gegeven, of afgenomen	`role`	`role_id`, `reach`, en `membership_id` of `group_id`
`access.group.member_added`, `access.group.member_removed`	de leden van een groep zijn veranderd	`group`	`group_id`, `membership_id`
`organisations.organisation.created`, `.erased`	een organisatie onder de jouwe is gemaakt, of haar verwijdering is klaar; vastgelegd in de jouwe	`organisation`	`organisation_id`
`organisations.organisation.suspended`, `.reactivated`	je organisatie is opgeschort of hervat	`organisation`	`organisation_id`, `status`
`organisation_settings.settings.changed`	de instellingen van je organisatie zijn veranderd	`organisation`	`fields`: de namen van de gewijzigde instellingen, nooit hun waarden
`service.plan.assigned`, `service.plan.removed`, `service.plan.lapsed`	de dienst van je organisatie kreeg een pakket, verloor er een, of een pakket liep af	`service`	`plan_id`, en `ends_at` bij een proefperiode
`exports.export.completed`, `exports.export.failed`	een export van je organisatie of van één lid staat klaar, of is mislukt	`export`	`export_id`, `scope`, `status`
`events.webhook.tested`	iemand stuurde een webhook een test; alleen naar die webhook, nooit in de feed	`event`	`subscription_id`

Grenzen¶

Wat	Grens
hoe lang OS een gebeurtenis en haar afleveringen bewaart	7 dagen
webhooks per organisatie	20
een pagina van de feed	ten hoogste 100 gebeurtenissen
afleveringen van één webhook die tegelijk verstuurd worden	4; 1 zolang hij faalt
hoe lang OS op je antwoord wacht	10 seconden
pogingen per aflevering	8, in ongeveer 45 uur
mislukkingen achter elkaar voordat een webhook faalt	5
falend voordat een webhook wordt uitgeschakeld	3 dagen
de overlap van een geheim na vervanging	0 tot 168 uur, standaard 24
een adres	`https`, een hostnaam, ten hoogste 2.048 tekens, poort 443

Artific kan voor jouw omgeving andere grenzen instellen.