API key

key.rotated

An API key`s secret value was rotated.

When it fires

After RotateKey succeeds via the internal rotate endpoint. The new key value is NOT in the payload, only the updated counter.

Payload

ts
{
    type: 'key.rotated',
    data: {
        key: {
            id: string
            name: string
            keyRolls: number  // monotonically increasing on each rotation
        }
    }
}

Example

json
{
    "type": "key.rotated",
    "data": {
        "key": {
            "id": "0192a1b2-c3d4-7000-8000-000000000090",
            "name": "CI deploy key",
            "keyRolls": 3
        }
    }
}