Ereignisse¶

Jede Art von Ereignis, die OS festhält, worum es geht und was ihre refs enthalten, sowie die Grenzen des Feeds und der Webhooks. GET /api/v1/event-kinds liefert dieselbe Liste als Daten. Was Ereignisse sind, steht unter Ereignisse und Webhooks.

Arten¶

Die refs einer Art wachsen nur: Es kommt ein Feld hinzu, nie verschwindet eines, und ein Feld bekommt nie eine andere Bedeutung. Eine Änderung, die Ihr Programm brechen würde, ist eine neue Art mit einem neuen Namen.

Art	Wann	Betrifft (`see` nötig)	`refs`
`directory.invitation.created`	eine Einladung wurde verschickt	`invitation`	`invitation_id`
`directory.invitation.accepted`	eine Einladung wurde angenommen	`invitation`	`invitation_id`, `membership_id`
`directory.invitation.revoked`	eine Einladung wurde zurückgezogen	`invitation`	`invitation_id`
`directory.invitation.expired`	eine Einladung ist abgelaufen	`invitation`	`invitation_id`
`directory.membership.created`	jemand ist Mitglied geworden	`membership`	`membership_id`, `principal_kind`, `status`
`directory.membership.deactivated`, `.reactivated`, `.removed`	der Status einer Mitgliedschaft hat sich geändert	`membership`	`membership_id`, `principal_kind`, `status`
`access.role.assigned`, `access.role.unassigned`	eine Rolle wurde einem Mitglied oder einer Gruppe gegeben oder genommen	`role`	`role_id`, `reach`, und `membership_id` oder `group_id`
`access.group.member_added`, `access.group.member_removed`	die Mitglieder einer Gruppe haben sich geändert	`group`	`group_id`, `membership_id`
`organisations.organisation.created`, `.erased`	eine Organisation unter Ihrer wurde angelegt, oder ihre Löschung ist abgeschlossen; festgehalten in Ihrer	`organisation`	`organisation_id`
`organisations.organisation.suspended`, `.reactivated`	Ihre Organisation wurde ausgesetzt oder fortgesetzt	`organisation`	`organisation_id`, `status`
`organisation_settings.settings.changed`	die Einstellungen Ihrer Organisation haben sich geändert	`organisation`	`fields`: die Namen der geänderten Einstellungen, nie ihre Werte
`service.plan.assigned`, `service.plan.removed`, `service.plan.lapsed`	der Dienst Ihrer Organisation bekam einen Plan, verlor einen, oder ein Plan lief ab	`service`	`plan_id`, und `ends_at` bei einem Testzeitraum
`exports.export.completed`, `exports.export.failed`	ein Export Ihrer Organisation oder eines Mitglieds ist fertig oder fehlgeschlagen	`export`	`export_id`, `scope`, `status`
`events.webhook.tested`	jemand hat einem Webhook einen Test geschickt; nur an diesen Webhook, nie in den Feed	`event`	`subscription_id`

Grenzen¶

Was	Grenze
wie lange OS ein Ereignis und seine Zustellungen aufbewahrt	7 Tage
Webhooks je Organisation	20
eine Seite des Feeds	höchstens 100 Ereignisse
Zustellungen eines Webhooks, die gleichzeitig verschickt werden	4; 1, solange er fehlschlägt
wie lange OS auf Ihre Antwort wartet	10 Sekunden
Versuche je Zustellung	8, in etwa 45 Stunden
Fehlschläge hintereinander, bevor ein Webhook als fehlerhaft gilt	5
fehlerhaft, bevor ein Webhook ausgeschaltet wird	3 Tage
die Überlappung eines Geheimnisses nach dem Ersetzen	0 bis 168 Stunden, Standard 24
eine Adresse	`https`, ein Hostname, höchstens 2.048 Zeichen, Port 443

Artific kann für Ihre Umgebung andere Grenzen festlegen.