RewardApproved

RewardApproved says that a collaborator’s rewards were approved by one approval action: a dashboard edit, a bulk approval, or approval when the sale completes. It fires once per collaborator per action, listing every conversion the action approved for them, so a bulk approval of fifty conversions for one collaborator raises one event. A conversion that was approved before, even one moved back to pending since, isn’t announced again.

The event is identified as reward_approved and lives in Siren\Conversions\Core\Events\RewardApproved. ConversionApproved still fires every time a conversion is approved.

What does this event carry?

• collaboratorId, the collaborator whose rewards were approved.
• conversions, the approved Conversion models as they stand after the change. getConversionIds() returns their ids.
• getObligationIds(), the obligations that hold the approved amounts, each once.
• programIds, the programs the conversions belong to, each once.
• propertyId, on Siren Cloud, the Property every reward came from, or null.

use Siren\Conversions\Core\Events\RewardApproved;

public function handle(Event $event): void
{
    $collaboratorId = $event->collaboratorId;
    $obligationIds = $event->getObligationIds();
    $programIds = $event->programIds;
}

When would you use it?

Use it to tell a collaborator their rewards were approved without sending one message per conversion. On Siren Cloud, this event sends the “Reward approved” email once a merchant switches it on.

On a WordPress site connected to Siren Cloud, Siren Cloud does this work, so the site doesn’t raise RewardApproved. The site does raise ConversionApproved for each conversion Siren Cloud approves, so listen for that there. Your own server can subscribe to the obligation.approved webhook, which Siren Cloud sends once for each reward that becomes owed.

See the Conversion Events overview for the rest of the conversion lifecycle.