cURL
curl --request GET \ --url https://api.sandbox.iron.xyz/api/webhooks \ --header 'X-API-Key: <api-key>'
{ "items": [ { "created_at": "2023-11-07T05:31:56Z", "enabled": true, "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "label": "<string>", "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "topics": [ "Transaction" ], "updated_at": "2023-11-07T05:31:56Z", "url": "<string>", "last_failure": "2023-11-07T05:31:56Z", "last_failure_reason": "<string>" } ], "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "prev_cursor": null }
Lists all webhooks for the currently authenticated partner
API Key
Paging: the cursor field from previous page
Paging: the requested page size (max 100)
Listing successful
PagedList
A list of items with cursors used to fetch the next or previous page
The list of items
Show child attributes
When the webhook was created
Whether the webhook is enabled
The ID of the webhook
A descriptive label for the webhook
The partner ID that owns this webhook
The topics this webhook subscribes to
Webhook Event Types
Represents the different types of webhook events that can be sent
Transaction
NewBankAccount
NewAutoramp
DepositAddressCreated
RegisterFiatAddressStatus
RegisterAutorampStatus
TransactionStatus
CustomerCreated
CustomerStatus
IdentificationStatus
Ping
When the webhook was last updated
The URL to send webhook events to
The last time the webhook was executed with an error
The reason for the last failure
The cursor used to fetch the next page
The cursor used to fetch the previous page