Skip to main content
POST
Create a liquidation alert
See the liquidation alerts guide for the message formats and how to verify a webhook signature.

Authorizations

Authorization
string
header
required

Ironflow API key, format if_xxxx. Free keys at https://ironflow.sh/key. Optional on read endpoints.

Body

application/json
telegram_chat
string

A Telegram chat instead of url: a public @channel or group name, or a numeric chat id (groups and channels start with -100). The bot named in setup must be in the chat (in a channel, as an admin that can post).

Example:

"@my_liquidations"

url
string

Where to post: https://discord.com/api/webhooks/..., https://hooks.slack.com/services/... or any public HTTPS URL (port 443 or 8443). Required unless telegram_chat is set.

Example:

"https://discord.com/api/webhooks/123/abc"

name
string

Shown in the message title.

Maximum string length: 80
Example:

"BTC and ETH longs"

markets

Markets to watch: symbols or Hyperliquid coin names, as a list or a comma-separated string (at most 50). Omit for every market.

Example:
side
enum<string>
default:any

The liquidated position: long means longs were liquidated.

Available options:
any,
long,
short
min_usd
number
default:0

Smallest liquidation to report, in USD.

Required range: x >= 0
Example:

100000

address
string

Only this wallet's liquidations.

Example:

"0xabc0000000000000000000000000000000000001"

Response

Alert created. signing_secret appears only here, and only for webhooks.

id
string<uuid>
name
string
type
enum<string>
Available options:
webhook,
discord,
slack,
telegram
destination
string

Host of the URL, without its secret part, or the Telegram chat.

Example:

"discord.com/…"

markets
string[]

Empty: every market.

Example:
side
enum<string>
Available options:
any,
long,
short
min_usd
number
Example:

100000

address
string
status
enum<string>

disabled after 20 failed deliveries in a row; a delivered test re-enables it.

Available options:
active,
disabled
failures
integer

Failed deliveries in a row.

last_error
string
Example:

"destination answered HTTP 404: Unknown Webhook"

last_sent_at
string<date-time> | null
sent_count
integer

Liquidations delivered so far.

created_at
string<date-time>
signing_secret
string

Webhooks only, in the create response only.

Example:

"whsec_3f9a..."

setup
string

Create response only: what to do before the first message arrives (Telegram: which bot to add to the chat).