Events¶
Every kind of event OS records, what it is about and what its refs hold, and the limits of the
feed and of webhooks. GET /api/v1/event-kinds answers the same list as data. What events are is
in Events and webhooks.
Kinds¶
A kind's refs only ever grow: a field is added, never removed or given another meaning. A change
that would break your program is a new kind with a new name.
| Kind | When | About (see needed) |
refs |
|---|---|---|---|
directory.invitation.created |
an invitation was sent | invitation |
invitation_id |
directory.invitation.accepted |
an invitation was accepted | invitation |
invitation_id, membership_id |
directory.invitation.revoked |
an invitation was revoked | invitation |
invitation_id |
directory.invitation.expired |
an invitation ran out | invitation |
invitation_id |
directory.membership.created |
someone joined | membership |
membership_id, principal_kind, status |
directory.membership.deactivated, .reactivated, .removed |
a membership's status changed | membership |
membership_id, principal_kind, status |
access.role.assigned, access.role.unassigned |
a role was given to, or taken from, a member or group | role |
role_id, reach, and membership_id or group_id |
access.group.member_added, access.group.member_removed |
a group's members changed | group |
group_id, membership_id |
organisations.organisation.created, .erased |
an organisation below yours was created, or its erasure finished; recorded in yours | organisation |
organisation_id |
organisations.organisation.suspended, .reactivated |
your organisation was suspended or resumed | organisation |
organisation_id, status |
organisation_settings.settings.changed |
your organisation's settings changed | organisation |
fields: the names of the settings changed, never their values |
service.plan.assigned, service.plan.removed, service.plan.lapsed |
your organisation's service gained, lost or ran out of a plan | service |
plan_id, and ends_at for a trial |
exports.export.completed, exports.export.failed |
an export of your organisation or of one member became ready, or failed | export |
export_id, scope, status |
events.webhook.tested |
someone sent a webhook a test; only to that webhook, never in the feed | event |
subscription_id |
Limits¶
| What | Limit |
|---|---|
| how long OS keeps an event and its deliveries | 7 days |
| webhooks per organisation | 20 |
| a feed page | at most 100 events |
| deliveries of one webhook being sent at once | 4; 1 while it is failing |
| how long OS waits for your answer | 10 seconds |
| attempts per delivery | 8, over about 45 hours |
| failures in a row before a webhook is failing | 5 |
| failing before a webhook is disabled | 3 days |
| a secret's overlap after a replacement | 0 to 168 hours, 24 by default |
| an address | https, a host name, at most 2,048 characters, port 443 |
Artific may set other limits for your environment.