A typical flow to implement Paylias webhooks within your application may look like the following
  1. Use the dashboard or the Create Webhook endpoint to subscribe to a single or multiple events.
  2. If you have decided to opt in for webhook signature verification, implement your application logic for Webhook Event Signature Verification.
  3. Enable your webhook subscription through the Update Webhook endpoint if you haven’t already done so.
  4. Trigger events by Creating a payment to test the logic for receiving events from Paylias. You can view event delivery logs and delivery-errors both through the API as well as on the dashboard.

Subscribing to events

Events in Paylias are structured as a JSON object with two keys:
  1. record_type: This is the resource for which the event is being triggered
  2. event_type: This is the operation on the resource that triggered the event.
Currently Paylias supports the following combination of record_types and event_types
record_typeEK_CreatedEK_Updated
RT_Paymentsyesyes
RT_PaymentSubmissionsyesyes
RT_PaymentAdmissionsyesyes
RT_PaymentAdmissionTasksyesyes
RT_Erroryesno
RT_Transactionsyesno
When creating a webhook subscription, you can have a single endpoint subscribe to a single or multiple combinations of record_type:event_type depending on your own internal use cases and logic handling.
While a single endpoint can subscribe to multiple events, an event can only be subscribed to a single endpoint. This means that if you already have an active subscription for a specific combination of record_type:event_type for example RT_Payments:EK_Created, you cannot resubscribe to this event through another endpoint.