GetWebhooks

post

https://apitest.myfatoorah.com/v2/GetWebhooks

Retrieves all webhook events triggered by MyFatoorah to your endpoint based on webhook configuration and delivery status. Useful for retrieving missed webhook events if your server was down or slow.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Start

date-time

Start date for filtering webhook events (format: ISO 8601) in UTC Time zone

End

date-time

End date for filtering webhook events (format: ISO 8601) in UTC Time zone

Page

integer

Page number for pagination (1-based). The number of events in a single page is 500 events.

EventType

string

enum

Webhook V1: TransactionsStatusChanged, RefundStatusChanged, RecurringStatusChanged, BalanceTransferred, SupplierStatusChanged, DisputeStatusChanged.

Webhook V2: PAYMENT_STATUS_CHANGED, REFUND_STATUS_CHANGED, RECURRING_UPDATES, BALANCE_TRANSFERRED, SUPPLIER_STATUS_CHANGED, DISPUTE_STATUS_CHANGED

Status

string

enum

Status of webhook attempts to filter: Waiting (not yet triggered from MyFatoorah), Running (The webhook is triggered from MyFatoorah but we are still attempting to reach your endpoint till we get success status code or all the retries are consumed.), Succeeded (successfully received), Failed (Your server failed to receive the webhook and all the retries are consumed.)

Allowed:

Key

array of strings

Array of Keys based on the KeyType

Key

KeyType

string

enum

InvoiceId: Filters for Payment Webhook with this InvoiceId.
CustomerReference: Filters for Payment Webhook with this CustomerReference.
WebhookReference: Filters for webhook events with this Webhook Reference

Allowed:

Response

200Successful response