Permission events

This page documents the webhook events related to permission operations in Scalekit.

Permission events

`permission.created`

This webhook is triggered when a new permission is created. The event type is permission.created

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_1234567890",
4
  "object": "Permission",
5
  "occurred_at": "2024-01-15T10:30:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "permission.created",
8
  "data": {
9
    "description": "Permission to manage data",
10
    "id": "perm_1234567890",
11
    "name": "data:manage"
12
  }
13
}

Field	Type	Description
`id`	string	Unique identifier for the permission
`name`	string	Unique name identifier for the permission
`description`	string	Description of what the permission allows

`permission.updated`

This webhook is triggered when a permission is updated. The event type is permission.updated

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_2345678901",
4
  "object": "Permission",
5
  "occurred_at": "2024-01-15T10:35:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "permission.updated",
8
  "data": {
9
    "description": "Updated permission to manage all data",
10
    "id": "perm_1234567890",
11
    "name": "data:manage"
12
  }
13
}

Field	Type	Description
`id`	string	Unique identifier for the permission
`name`	string	Unique name identifier for the permission
`description`	string	Description of what the permission allows

`permission.deleted`

This webhook is triggered when a permission is deleted. The event type is permission.deleted

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_3456789012",
4
  "object": "Permission",
5
  "occurred_at": "2024-01-15T10:40:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "permission.deleted",
8
  "data": {
9
    "description": "Updated permission to manage all data",
10
    "id": "perm_1234567890",
11
    "name": "data:manage"
12
  }
13
}

Field	Type	Description
`id`	string	Unique identifier for the deleted permission
`name`	string	Unique name identifier for the deleted permission
`description`	string	Description of what the permission allowed