---
title: "GetWebhooks"
method: POST
path: "/v2/GetWebhooks"
tags: ["Webhook"]
---

# GetWebhooks

`POST /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.

## Request body

- object
  - `Start` string, date-time — Start date for filtering webhook events (format: ISO 8601) in UTC Time zone
  - `End` string, 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` 'TransactionsStatusChanged' | 'RefundStatusChanged' | 'RecurringStatusChanged' | 'BalanceTransferred' | 'SupplierStatusChanged' | 'DisputeStatusChanged' | 'PAYMENT_STATUS_CHANGED' | 'REFUND_STATUS_CHANGED' | 'RECURRING_UPDATES' | 'BALANCE_TRANSFERRED' | 'SUPPLIER_STATUS_CHANGED' | 'DISPUTE_STATUS_CHANGED' — 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` 'Waiting' | 'Running' | 'Succeeded' | 'Failed' — 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.)
  - `Key` string[] — Array of Keys based on the KeyType
  - `KeyType` 'InvoiceId' | 'CustomerReference' | 'WebhookReference' — 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

## Response `200`

Successful response

- object
  - `IsSuccess` boolean — Indicates if the request was successful
  - `Message` string — Status or result message
  - `ValidationErrors` object[] — List of validation errors if any
    - `Name` string
    - `Error` string
  - `Data` object — Contains the response details
    - `Items` object[] — List of webhook event log items
      - `EndPoint` string — The URL where the webhook notification was sent
      - `Signature` string — Signature for verifying the webhook payload
      - `EventCode` integer — Numeric code for the event type
      - `EventName` string — Name of the event (V1: TransactionsStatusChanged, RefundStatusChanged, etc. V2: PAYMENT_STATUS_CHANGED, REFUND_STATUS_CHANGED, etc.)
      - `EventEntityId` string — Identifier for the entity associated with the event
      - `WebhookReference` string — Unique reference for the webhook event
      - `Data` object — The webhook data content
      - `Status` string — Status of the webhook event delivery (Waiting, Running, Succeeded, Failed)
      - `Attempts` object[] — List of delivery attempt objects
        - `Date` string, date-time — Datetime of the attempt (format: ISO 8601) in UTC Time zone
        - `Status` integer — The status code received from your server for the attempt
        - `Response Message` string — The message corresponding to the status code received
        - `Duration` string — The number of seconds it took for your server to respond to the attempt
    - `Pagination` object — Pagination information
      - `PageSize` integer — The size of the page (Fixed: 500)
      - `PageNumber` integer — The page you are currently on
      - `PagesCount` integer — The number of pages with webhook events matching the filters
      - `ItemsCount` integer — The number of webhook events matching the filters

---

[API](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3.md) · [All operations](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myfatoorah/myfatoorah-api-v3/revisions/994a74287a16/schema)