Skip to main content
POST
Create subscription

Authorizations

Authorization
string
header
required

To test endpoints here, paste your API key from the Dashboard into the username field and leave the password empty.

Body

application/json
callback_url
string
required

Callback URL that notifications are delivered to.

Example:

"https://webhook.site/fcd606d2-f5bd-4832-9874-ff07c980b5a3"

addresses
string[]
required

Wallet addresses to subscribe, up to 100 on the create call. Add more in batches of 100 with PATCH /v1/tx-subscriptions/{subscription_id}/wallets.

Free tier accounts are limited to 5 addresses per subscription.

A wallet address.

chain_ids
string[]

Chains to report transactions from. Only chains reporting both supports_transactions and supports_positions in the flags of GET /v1/chains/ are accepted here. Naming a chain that fails that gate returns 400 rather than an empty result, with detail reading chain <id> does not support transactions. That detail names the endpoint's capability rather than the flag that failed, so bob is refused with chain bob does not support transactions even though it reports supports_transactions. What it lacks is supports_positions. Leave the list empty to subscribe to every chain that passes the gate. Chains that fail it are left out silently, with no error and no meta signal.

filters
object | null

Exclusion filters for the subscription. Conditions are combined with OR: an event matching any one of them is dropped and no webhook is delivered for it. Filters are absent from the response when none are set. What omitting the field or sending null means is specific to the request that carries it: see that operation's own description.

Field paths below refer to the delivered webhook transaction payload, not to this subscription resource. A condition does not match an event lacking the value it compares, so an event with no dapp is not excluded by protocol_ids.

Callbacks

POST
<your webhook URL>TransactionCallback

Body

application/json

Response for requested list of transactions

data
object
required
included
object[]

Response

Successful callback processing

Response

Response for requested wallet's transactions subscription

data
object
required