Skip to content
RelayKit PHP

Event Mapping

Event mapping

Event mapping connects provider event names to application handlers.

'events' => [
    'payments.payment_succeeded' => App\Webhooks\Handlers\PaymentSucceededHandler::class,
    'payments.payment_failed' => App\Webhooks\Handlers\PaymentFailedHandler::class,
],

Namespaced event names

RelayKit prefixes event names with the provider key.

A provider registered as payments with an incoming event named payment_succeeded becomes:

payments.payment_succeeded

This prevents collisions when different providers use the same event name.

Fallback handlers

You can define a fallback handler for unknown events.

'fallback_handler' => App\Webhooks\Handlers\UnknownWebhookHandler::class,

Fallback handlers are useful during development when providers add new event types.

Ignoring events

Ignored events are verified and logged, but not dispatched.

'ignored_events' => [
    'payments.invoice_viewed',
],

© RelayKit PHP