Integration Plugin Development

plugins/integration-slack/
├── manifest.json
├── Plugin.php
├── src/
│   └── SlackNotifier.php
├── config/
│   └── settings.php
└── resources/
    └── views/
        └── settings.twig

{
  "name": "Slack Notifications",
  "slug": "integration-slack",
  "version": "1.0.0",
  "type": "integration",
  "description": "Send payment events to a Slack channel",
  "author": "Your Name",
  "capabilities": ["addon", "hooks", "http_outbound", "settings"],
  "minimumOwnPayVersion": "0.2.0"
}

<?php
declare(strict_types=1);

namespace OwnPay\Plugins\IntegrationSlack;

use OwnPay\Container;
use OwnPay\Event\EventManager;
use OwnPay\Plugin\Capability;
use OwnPay\Plugin\PluginInterface;

final class Plugin implements PluginInterface
{
    public static function metadata(): array
    {
        return [
            'name'        => 'Slack Notifications',
            'slug'        => 'integration-slack',
            'version'     => '1.0.0',
            'description' => 'Send payment events to Slack.',
            'author'      => 'Your Name',
            'type'        => 'integration',
        ];
    }

    public function capabilities(): array
    {
        return [Capability::ADDON, Capability::HOOKS, Capability::HTTP_OUTBOUND];
    }

    public function register(EventManager $events, Container $container): void
    {
        $notifier = new SlackNotifier($container);

        $events->addAction('payment.transaction.completed', function (array $txn) use ($notifier): void {
            $notifier->send(":white_check_mark: Payment *{$txn['amount']} {$txn['currency']}*\n"
                . "Transaction: `{$txn['trx_id']}`\n"
                . "Gateway: {$txn['gateway']}"
            );
        });

        $events->addAction('payment.transaction.failed', function (array $txn) use ($notifier): void {
            $notifier->send(":x: Payment *failed*\n"
                . "Amount: {$txn['amount']} {$txn['currency']}\n"
                . "Transaction: `{$txn['trx_id']}`\n"
                . "Gateway: {$txn['gateway']}"
            );
        });

        $events->addAction('refund.issued', function (array $txn) use ($notifier): void {
            $notifier->send(":arrows_counterclockwise: Refund issued\n"
                . "Amount: {$txn['amount']} {$txn['currency']}"
            );
        });
    }

    public function boot(Container $container): void {}
    public function deactivate(Container $container): void {}
    public function uninstall(Container $container): void {}

    public function fields(): array
    {
        return [
            [
                'name'     => 'webhook_url',
                'label'    => 'Slack Webhook URL',
                'type'     => 'text',
                'required' => true,
            ],
        ];
    }
}

<?php
declare(strict_types=1);

namespace OwnPay\Plugins\IntegrationSlack;

use OwnPay\Container;
use OwnPay\Repository\SettingsRepository;

class SlackNotifier
{
    private string $webhookUrl;

    public function __construct(Container $container)
    {
        $settings = $container->get(SettingsRepository::class);
        $this->webhookUrl = $settings->get('integration-slack', 'webhook_url') ?? '';
    }

    public function send(string $message): void
    {
        if ($this->webhookUrl === '') {
            return;
        }

        $payload = json_encode(['text' => $message]);

        $ch = curl_init($this->webhookUrl);
        curl_setopt_array($ch, [
            CURLOPT_POST           => true,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_TIMEOUT        => 5,
            CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
            CURLOPT_POSTFIELDS     => $payload,
        ]);
        curl_exec($ch);
        curl_close($ch);
    }
}