Eventos¶
Cada tipo de evento que OS registra, de qué trata y qué contienen sus refs, y los límites del feed y de los webhooks. GET /api/v1/event-kinds da la misma lista como datos. Qué son los eventos está en Eventos y webhooks.
Tipos¶
Las refs de un tipo solo crecen: se añade un campo, nunca desaparece ninguno y un campo nunca cambia de significado. Un cambio que rompería tu programa es un tipo nuevo con un nombre nuevo.
| Tipo | Cuándo | Trata de (hace falta see) |
refs |
|---|---|---|---|
directory.invitation.created |
se envió una invitación | invitation |
invitation_id |
directory.invitation.accepted |
se aceptó una invitación | invitation |
invitation_id, membership_id |
directory.invitation.revoked |
se retiró una invitación | invitation |
invitation_id |
directory.invitation.expired |
caducó una invitación | invitation |
invitation_id |
directory.membership.created |
alguien se hizo miembro | membership |
membership_id, principal_kind, status |
directory.membership.deactivated, .reactivated, .removed |
cambió el estado de una pertenencia | membership |
membership_id, principal_kind, status |
access.role.assigned, access.role.unassigned |
se dio un rol a un miembro o grupo, o se quitó | role |
role_id, reach, y membership_id o group_id |
access.group.member_added, access.group.member_removed |
cambiaron los miembros de un grupo | group |
group_id, membership_id |
organisations.organisation.created, .erased |
se creó una organización bajo la tuya, o terminó su eliminación; registrado en la tuya | organisation |
organisation_id |
organisations.organisation.suspended, .reactivated |
tu organización se suspendió o se reanudó | organisation |
organisation_id, status |
organisation_settings.settings.changed |
cambiaron los ajustes de tu organización | organisation |
fields: los nombres de los ajustes modificados, nunca sus valores |
service.plan.assigned, service.plan.removed, service.plan.lapsed |
el servicio de tu organización recibió un plan, perdió uno, o un plan caducó | service |
plan_id, y ends_at en un periodo de prueba |
exports.export.completed, exports.export.failed |
una exportación de tu organización o de un miembro está lista, o ha fallado | export |
export_id, scope, status |
events.webhook.tested |
alguien envió una prueba a un webhook; solo a ese webhook, nunca al feed | event |
subscription_id |
Límites¶
| Qué | Límite |
|---|---|
| cuánto tiempo conserva OS un evento y sus entregas | 7 días |
| webhooks por organización | 20 |
| una página del feed | como máximo 100 eventos |
| entregas de un mismo webhook enviadas a la vez | 4; 1 mientras falla |
| cuánto espera OS tu respuesta | 10 segundos |
| intentos por entrega | 8, en unas 45 horas |
| fallos seguidos antes de que un webhook pase a fallando | 5 |
| fallando antes de que un webhook se desactive | 3 días |
| el solapamiento de un secreto tras reemplazarlo | de 0 a 168 horas, 24 por defecto |
| una dirección | https, un nombre de host, como máximo 2.048 caracteres, puerto 443 |
Artific puede fijar otros límites para tu entorno.