API key

key.updated

A key was renamed, re-scoped, or enabled/disabled.

When it fires

After UpdateKeyService succeeds. changes lists which DB fields were updated.

Payload

ts

{
    type: 'key.updated',
    data: {
        key: {
            id: string
            name: string
            active: boolean
        }
        changes: Array<'name' | 'active' | 'enabledAt' | 'disabledAt' | 'scopes' | 'projectIds'>
    }
}

Example

json

{
    "type": "key.updated",
    "data": {
        "key": {
            "id": "0192a1b2-c3d4-7000-8000-000000000090",
            "name": "CI deploy key",
            "active": false
        },
        "changes": ["active", "disabledAt"]
    }
}