PayoutSent

PayoutSent says that a payout reached its collaborator: an admin marked it paid, or Siren paid it out automatically. It fires once per payout. Marking a payout unpaid and then paid again raises PayoutPaid a second time, because the payout changed again, but raises nothing here, because the collaborator was paid once.

The event is identified as payout_sent and lives in Siren\Fulfillments\Core\Events\PayoutSent.

What does this event carry?

The event carries the Payout as it stands after the change, so a listener can describe the payout without reading it again. getPayout() returns it, and getPayoutId() and getCollaboratorId() are shortcuts.

use Siren\Fulfillments\Core\Events\PayoutSent;

public function handle(Event $event): void
{
    $payout = $event->getPayout();
    $amount = $payout->getValue();
    $currency = $payout->getCurrency();
    $fulfillmentId = $payout->getFulfillmentId();
}

When would you use it?

Use it for anything that should happen exactly once per payout, such as telling a collaborator they were paid. Use PayoutPaid instead for logic that must follow every change to paid, such as reconciliation. On Siren Cloud, this event sends the “Payout sent” email and the payout.paid webhook.

On a WordPress site connected to Siren Cloud, Siren Cloud pays the payouts, so the site doesn’t raise PayoutSent. Each payout.paid delivery from Siren Cloud arrives on the site as PayoutPaid.

See the Payment Events overview for how this event fits into the payment pipeline.