# CloudManagementEvent events

> 5 FeatherPanel plugin events on CloudManagementEvent (4 emitted by the core): the event names, the arguments each listener gets, where they fire and a PHP listener for each.

Source: https://featherpanel.com/docs/plugins/events/cloud-management/

Part of the [plugin events reference](https://featherpanel.com/docs/plugins/events/). Listeners get the payload values as positional arguments in the order shown, cannot cancel the action, and must catch their own exceptions. 1 of these events are declared but no code emits them yet; they are marked not emitted.

## Setup

Import `CloudManagementEvent` in your entry class and register listeners in `processEvents()`:

```php
<?php

namespace App\Addons\myplugin;

use App\App;
use App\Plugins\AppPlugin;
use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\CloudManagementEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(CloudManagementEvent::onCloudCredentialsRetrieved(), function ($credentials): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:cloud:credentials:retrieved ' . json_encode(['credentials' => $credentials]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}
```

## `CloudManagementEvent::onCloudCredentialsStored()`

- Name: `featherpanel:admin:cloud:cloud:credentials:stored`
- emitted at 2 sites
- 2 payload shapes
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/CloudManagementEvent.php#L44)

Docblock: array credentials data. (the emitter passes 2 values, see the table)

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `credentials` | `$credentials` | `array` |
| 2 | `stored_by` | `$storedBy` | not declared |

| Arguments passed | Emitted from |
| --- | --- |
| `credentials`, `stored_by` | 
`CloudManagementController::storeCloud`

 |
| `credentials`, `stored_by`, `source`, `team_uuid`, `mythic_user_id` | 

`CloudManagementController::saveOAuth2Callback`

 |

When it fires (2 sites)

-   [`CloudManagementController::storeCloud`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/CloudManagementController.php#L263)[`PUT /api/admin/cloud/credentials/cloud`](https://featherpanel.com/docs/api/reference/admin/cloud/#put-admin-cloud-credentials-cloud)
-   [`CloudManagementController::saveOAuth2Callback`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/CloudManagementController.php#L676)[`POST /api/admin/cloud/oauth2/callback`](https://featherpanel.com/docs/api/reference/admin/cloud/#post-admin-cloud-oauth2-callback)

```php
$event->on(CloudManagementEvent::onCloudCredentialsStored(), function ($credentials, $storedBy, ...$rest): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:cloud:cloud:credentials:stored ' . json_encode(['credentials' => $credentials]));
});
```

## `CloudManagementEvent::onCloudCredentialsRetrieved()`

- Name: `featherpanel:admin:cloud:credentials:retrieved`
- emitted at 1 site
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/CloudManagementEvent.php#L28)

Docblock: array credentials data.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `credentials` | `$credentials` | `array` |

When it fires (1 site)

-   [`CloudManagementController::show`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/CloudManagementController.php#L115)[`GET /api/admin/cloud/credentials`](https://featherpanel.com/docs/api/reference/admin/cloud/#get-admin-cloud-credentials)

```php
$event->on(CloudManagementEvent::onCloudCredentialsRetrieved(), function ($credentials): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:cloud:credentials:retrieved ' . json_encode(['credentials' => $credentials]));
});
```

## `CloudManagementEvent::onCloudCredentialsRotated()`

- Name: `featherpanel:admin:cloud:credentials:rotated`
- emitted at 1 site
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/CloudManagementEvent.php#L52)

Docblock: string credential type. (the emitter passes 2 values, see the table)

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `credential_type` | `$credentialType` | `string` |
| 2 | `rotated_by` | `$rotatedBy` | not declared |

When it fires (1 site)

-   [`CloudManagementController::rotate`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/CloudManagementController.php#L337)[`POST /api/admin/cloud/credentials/rotate`](https://featherpanel.com/docs/api/reference/admin/cloud/#post-admin-cloud-credentials-rotate)

```php
$event->on(CloudManagementEvent::onCloudCredentialsRotated(), function ($credentialType, $rotatedBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:cloud:credentials:rotated ' . json_encode(['credential_type' => $credentialType]));
});
```

## `CloudManagementEvent::onCloudManagementError()`

- Name: `featherpanel:admin:cloud:error`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/CloudManagementEvent.php#L61)

Docblock: string error message, array context.

```php
$event->on(CloudManagementEvent::onCloudManagementError(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:cloud:error ' . json_encode($args));
});
```

No code emits this event yet, so the arguments are unknown. The listener accepts any.

## `CloudManagementEvent::onPanelCredentialsStored()`

- Name: `featherpanel:admin:cloud:panel:credentials:stored`
- emitted at 1 site
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/CloudManagementEvent.php#L36)

Docblock: array credentials data. (the emitter passes 2 values, see the table)

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `credentials` | `$credentials` | `array` |
| 2 | `stored_by` | `$storedBy` | not declared |

When it fires (1 site)

-   [`CloudManagementController::storePanel`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/CloudManagementController.php#L184)[`PUT /api/admin/cloud/credentials/panel`](https://featherpanel.com/docs/api/reference/admin/cloud/#put-admin-cloud-credentials-panel)

```php
$event->on(CloudManagementEvent::onPanelCredentialsStored(), function ($credentials, $storedBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:cloud:panel:credentials:stored ' . json_encode(['credentials' => $credentials]));
});
```