Siren

PayoutCreated

Fires when an individual payout record is created within a fulfillment.

WordPress plugin

Last updated: October 26, 2026

Within a fulfillment batch, each collaborator who is owed money gets an individual payout record. When one of these records is created, Siren fires PayoutCreated. A single fulfillment paying three collaborators will produce three separate PayoutCreated events, one per payout.

The event is identified as payout_created and lives in Siren\Fulfillments\Core\Events\PayoutCreated.

What does this event carry?

The event provides the Payout model, which contains the disbursement amount, currency, and the collaborator who will receive the payment.

use Siren\Fulfillments\Core\Events\PayoutCreated;

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

When would you use it?

On Siren Essentials and up, Siren itself listens for this event to send the payout automatically when its currency has a payout method. The payout moves to processing, then to paid or to failed with a reason. See Autofulfillers.

Listeners subscribe to this event to react when a specific collaborator’s payout is queued. Common use cases include notifying the collaborator that a payment is being prepared, validating payment details before disbursement, or syncing payout records to external payment platforms.

When the payout is marked paid, the system fires PayoutPaid.

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

Your privacy choices

Account, checkout and chat you request work without optional tracking. Choose whether to allow these other uses on this website.

You can change or withdraw your choices at any time using “Privacy choices.” We remember your choice for 180 days. Read our privacy policy.