'/%3e%3cdefs%3e%3cpattern%20id='pattern0_2104_4598'%20patternContentUnits='objectBoundingBox'%20width='1'%20height='1'%3e%3cuse%20xlink:href='%23image0_2104_4598'%20transform='matrix(0.00376176%200%200%200.0172414%20-0.00219436%200)'/%3e%3c/pattern%3e%3cimage%20id='image0_2104_4598'%20width='267'%20height='58'%20preserveAspectRatio='none'%20xlink:href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQsAAAA6CAMAAACQ2ozcAAAAM1BMVEVMaXH////////////////////////////////////////////////////////////////x7/yuAAAAEHRSTlMAoDDgEPBgwIBAINCwkHBQDIOTDwAAAAlwSFlzAAFxGAABcRgB7MGwCAAABm1JREFUaIHlW+uWsyoMLSIIeH3/pz0CKrmgQuusdn0nf2YaMW42kISgr1cQK+SySj+61/9cmm45RLTfRvNV0WoBIptv4/mi6AWLuiVDd0lKmLPGGPsA0nelGG8TZoXU69poTPi/v1smBjB338dZxvk218B/VIrxBl8hth9t73+Zp2x7SdNuLMX+tJTitZCKjQx1MzFquLBVc+hvpBSv8NMX/Hb+Bv2MbS8DaNsVYn9aSvFK2nWB5slHtr0sUL4Ur0vx+usowdL3A1jBhUVcfGmR1HCBFPbvuWhskvuefC4/wkWbWyMgzV2ub39GarhA+cf0KBevHrTdffSvcuGxonzCA73JBGq4gFnt7qN/lYtxwflEWOA3KWJVriWOpkd0+lUuQj6Rsu6QkcuL9jW2o4xbyzTZfpWLOG79FlatgnP5Y9tRnFn3RAYE7p/loo1bJ6GtnSLIYbuwRrz8rq6SCyY/y8W2UU0SFkw7xQCghszN/y4Xr0ZCKjpPxQz46Vjdj9pupiHUBsxclmRXcOG0CKZHfVV9dHqM1QmRrZNU4IVN15kwQ98fNHSlYNsaUsmmEUw899gNuQCck2ur17KwZXcypM6gsVSCtSN4YcozzLmWqtvbNCPRUDKgbU07RiC/z8XgmOnMtHNiYUJZu8Tbg8YW3B6HOK6PwRPQRo1sT21nBGVq73OxKNaElx8n3iiAR4CL8YbOHlH0YHnXtAL2osg2Gr8PuMgIIaPNTIooqIJdijfkyFO6b6u9gBTDo1M1PKOK6bNcYCBtf9Gwqcc7LHgr1qqFaHil69Y2KAY9zMWe/Ny3BWSU4vVdZ3UtvCHxGuQD7m2nmfY0FyBBGK8bJidXitf/gxbA7DVQwStdBbbVng48zsUxMexdy7EWr/8H9dw/QjJNLRfHKnmci2Pk5G1LW4nX/2U9x5p5eYOLvYj6PBfb+qXHfacWy/H6P6yuhavBfl1Cl0VtK7MaaGcS30wZF6ny2WS4kD71ttjyZgXHEDk5j4Ew2dTh9SbREYCEqA/NBBXY9pHX4E2eLOPiRQT1RsDAv0sc7QZhOHowIwxjHd4wDcDEmCJ1jmjQREG2werBxt3HXKRIwE+cEAYwmMijygze/hxvrq6FNJp0mNp2Zxf0x1ykWD8zLmA7lIChqe+u8U4Eb2goLbjYSaCJdnDqC20jR4JOAMzHXADYjAs4pCj5QYvH3uCFVjy66IR6Y8zoSfDlPr1rhEKdyHCB64GwJ8PHXAA144L3eBcYaw3DixwfW3skqw+GcUpHj1fP60TwSveXXKDRP7fAubjBi2bKwnrAT5p/gAsEEFuA41jNBQ60YZEip8Lq4r/NBexOLRfbvX0XfGZY5i5uVjcNOzs6tz0S23/GhYNctKcWKrmI4Sq+2BlebpRm9FSY8IRYcVTndS3si6DrEX/JBfKdeKjgitcMLw4DxNf7oVcHW/viSLt/kfqV46KHF9BofR5Tr7iA0QKhg6lIJqZe4Q3hExAroJEgIe6c17XgpEOeZy7ighatS7mA0RDlTyiJr8Obr2sJqjmva4H1g7eObREXNEiVcoGeBWqKuXy7FG9kBEhwfyjPZG9wkQOVfJlgS/Bu9+wbyy5z7YoLNL2XfgNMisFTBd6+qH5xW9fqjbV6JLUVfc4FzuS6yVoz3Lyzw7jAi2SlfrWiBTkhaOvwZrnomaa6lrNPxRwX2ft1JRe3Jb40mUvxkmc+Vtcy0NyFjgIv5oJOjEz39nVXitf/Rb6c+4txufQXWTkqpjkuXrnDLlnLhcsfmSU5Up9SvP7ZvK7F4shFXSsrB5lZLrLHXbzGd80FziS4pN15Kd6QXIGJYUhftolyXtfKSgrBWS5c7p6plguyayJyFmcv8IZRT1nmHnKJ5jzvzAoormS5yFoYqrm4AgI//LjFu3cvkKvioLQp2qlIlQseSuEXQYDt7JqFiVmei+wqqeeCfBIFewcT5XK80R+rwZgNx/F60qEhm3Zgu+HHuxK54hMucmTYei5e7B2NCD37hknAy9tDvPS0WjDNef1iTUQMploZvKc942L/3Aj0sXmDi9UOGw0KoQovzAPD2miRhr35mr7fCo3BO0K9pq/ONOBbL03NpIfIcXNQI2gP2gIteym5gSmkGvgbmRd4J/aqj93zFiUc1VCSc+K0WWWytd+HtHZ678YTQ2Yu+4jSzVePbcNVe6n51+U/wZKesx3N5aEAAAAASUVORK5CYII='/%3e%3c/defs%3e%3c/svg%3e)
Overview
Subscriptions monitor blockchain activity at an address and deliver matching on-chain events to your webhook URL. Use the /subscriptions endpoints to manage subscriptions; use /subscriptions/events to list, inspect, and retry the delivery events those subscriptions emit.
- List subscriptionsGET/subscriptions
- Create subscriptionPOST/subscriptions
- Get subscriptionGET/subscriptions/:id
- Update subscriptionPATCH/subscriptions/:id
- Delete subscriptionDELETE/subscriptions/:id
- Rotate signing secretPOST/subscriptions/:id/rotate-secret
- List delivery eventsGET/subscriptions/events
- Get delivery eventGET/subscriptions/events/:id
- Retry delivery eventPOST/subscriptions/events/:id/retry
List Subscriptions
Use Case
Returns a paginated list of subscriptions for the organization, filterable by chain, network, and status.
Query Parameters
Opaque cursor — pass `next_cursor` from a prior response to fetch the next page.
Opaque cursor for reverse pagination.
Page size.
Filter by blockchain (e.g., `ethereum`, `tron`).
Filter by network (e.g., `mainnet`, `testnet`).
Filter by subscription status.
Create Subscription
Use Case
Creates an address subscription to monitor blockchain activity. Matching events are POSTed to webhook_url.
Request Body
On-chain address to monitor.
Blockchain the address lives on (e.g., `ethereum`, `tron`).
HTTPS endpoint that will receive delivery events.
Network within the chain (e.g., `mainnet`, `testnet`).
Specific event type to monitor (e.g., `transfer`). Defaults to all event types.
Free-form label for your own bookkeeping.
Arbitrary key-value JSON returned back on every subscription read.
Create Subscription Response
data is a single SubscriptionResponse — the same object shape used in each entry of List Subscriptions Response. Refer there for the per-field explanations.
Get Subscription
Use Case
Returns a single subscription by ID.
Get Subscription Response
data is a single SubscriptionResponse — the same object shape used in each entry of List Subscriptions Response. Refer there for the per-field explanations.
Update Subscription
Use Case
Partially updates a subscription. Only event_type and webhook_url can be changed.
Request Body
Updated event type to monitor.
Updated webhook endpoint.
Delete Subscription
Use Case
Soft-deletes the subscription and detaches it from the upstream provider. Subsequent on-chain events will not be delivered.
Response: 204 No Content — empty body.
Rotate Signing Secret
Use Case
Generates a new HMAC signing secret for this subscription's webhook URL. The new secret is returned once — store it before the response closes.
The plaintext signing_secret is returned only on this response. Subsequent reads only expose a masked form. Use it to verify the signature header on every delivery.
Rotate Signing Secret Response
Resource type identifier. Always `signing_secret`.
The new HMAC signing secret. Returned only on this response — store it before the response closes.
List Delivery Events
Use Case
Returns a paginated list of on-chain delivery events across all subscriptions, newest first. Filterable by delivery status or subscription ID.
Query Parameters
Opaque cursor — pass `next_cursor` from a prior response to fetch the next page.
Opaque cursor for reverse pagination.
Page size.
Filter by delivery status: `pending`, `delivered`, or `failed`.
Narrow to a single subscription.
Get Delivery Event
Use Case
Returns a single delivery event by ID. The event must belong to the caller's organization.
Get Delivery Event Response
data is a single EventResponse — the same object shape used in each entry of List Delivery Events Response. Refer there for the per-field explanations.
Retry Delivery Event
Use Case
Re-queues a specific delivery for another attempt. Useful for delivering events that previously failed.