List webhook deliveries - Framnex for Developers

Returns a page of webhook deliveries of your organization: the webhook type and payload, the delivery state
(pending, sent or failed), the number of attempts and, for a failed delivery, the reason. Set
Filter.Type to list the deliveries of one webhook type.

Each webhook is sent once. If your endpoint does not confirm it with a 2xx status, the delivery becomes
failed and is not retried automatically: use this list to find such deliveries and resend them with
POST /integration/webhooks/{id}/retry.

Deliveries are sorted by creation time, newest first, unless Sorting.SortBy is set.
PagedFilter.PageNumber starts at 1; PagedFilter.PageSize defaults to 10.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "type": "outgoingTransferExecuted",
            "state": "pending",
            "failureReason": "string",
            "sentAt": "2019-08-24T14:15:22.123Z",
            "attempts": 0,
            "payload": {
                "transferId": "e240f72a-b0bc-4f57-ab86-5b78f1d8ea9b",
                "type": "outgoingTransferExecuted",
                "feeAmount": 0,
                "details": [
                    {
                        "type": "crypto",
                        "txHash": "string",
                        "gas": {
                            "gasPaymentId": "2276332b-f8b0-4d66-92d8-55d8621398f1",
                            "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
                            "amount": 0,
                            "currency": "string"
                        }
                    }
                ]
            }
        }
    ],
    "page": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalRecords": 0,
        "totalPages": 0
    }
}

🟠400

🟠401

🟠403

🔴500