Email Events Actions
Actions for Email Events. Every other area is listed on the Action Hooks Reference. Each name links to its own page, with its parameters, notes and an example.
Fire around dispatch of any Benecaster email, a test send and a broadcast, and around a subscriber’s opt-out state, for logging, monitoring send failures, or reacting to unsubscribes.
| Hook | Description |
|---|---|
benecaster_before_email_send |
Fires before any Benecaster email is dispatched, except a test send; use for logging (type-specific variant: benecaster_before_email_send_{type}) |
benecaster_after_email_send |
Fires after any Benecaster email is queued, not delivered, except a test send; carries the queue row id (type-specific variant: benecaster_after_email_send_{type}) |
benecaster_test_email_queued |
Fires when a test send is queued, in place of the before- and after-send actions |
benecaster_before_broadcast_send |
Fires once per broadcast, in the request that sent it, with its recipients and before any is queued |
benecaster_after_broadcast_send |
Fires once per broadcast, from the background batch that queues its last recipient, with how many were queued, suppressed and skipped |
benecaster_email_send_failed |
Fires when an email could not be queued |
benecaster_email_suppressed |
Fires when benecaster_email_should_send refuses a send, with the reason |
benecaster_email_unsubscribed |
Fires after a subscriber’s email opt-out is recorded |
benecaster_email_resubscribed |
Fires when a subscriber re-opts in to emails after previously opting out; Benecaster has no screen that triggers it |
benecaster_email_queue_job_complete |
Fires when all rows in a job group reach terminal status (sent or failed); use to update migration or broadcast status records |
See Also
Need this built rather than just documented? See our services →