{ "opencollection": "1.0.0", "info": { "name": "Helius API Catalog Addresses Webhooks API", "version": "1.0.0" }, "items": [ { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Returns all webhooks.", "type": "http" }, "http": { "method": "GET", "url": "https://mainnet.helius-rpc.com/v0/webhooks", "params": [ { "name": "api-key", "value": "", "type": "query", "description": "Helius API key. Obtain from https://dashboard.helius.dev or via `helius signup --json`." } ] }, "docs": "Retrieve a complete list of all configured webhooks for your API key with detailed\nconfiguration information including trigger conditions, delivery endpoints, and status.\n" }, { "info": { "name": "Creates a webhook.", "type": "http" }, "http": { "method": "POST", "url": "https://mainnet.helius-rpc.com/v0/webhooks", "params": [ { "name": "api-key", "value": "", "type": "query", "description": "Helius API key. Obtain from https://dashboard.helius.dev or via `helius signup --json`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new webhook for real-time Solana blockchain notifications. Configure triggers \nbased on addresses, transaction types, or specific on-chain events. Customize delivery \noptions and notification formatting for seamless integration with your application.\n" }, { "info": { "name": "Returns given Webhook.", "type": "http" }, "http": { "method": "GET", "url": "https://mainnet.helius-rpc.com/v0/webhooks/:webhookID", "params": [ { "name": "webhookID", "value": "", "type": "path", "description": "The webhook ID — a UUIDv4 that uniquely identifies the webhook." }, { "name": "api-key", "value": "", "type": "query", "description": "Helius API key. Obtain from https://dashboard.helius.dev or via `helius signup --json`." } ] }, "docs": "Retrieve detailed information about a specific webhook configuration by its unique ID.\nAccess complete webhook settings including trigger conditions, delivery endpoints, and status metrics.\n" }, { "info": { "name": "Edits a webhook.", "type": "http" }, "http": { "method": "PUT", "url": "https://mainnet.helius-rpc.com/v0/webhooks/:webhookID", "params": [ { "name": "webhookID", "value": "", "type": "path", "description": "The webhook ID — a UUIDv4 that uniquely identifies the webhook." }, { "name": "api-key", "value": "", "type": "query", "description": "Helius API key. Obtain from https://dashboard.helius.dev or via `helius signup --json`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing webhook configuration with new trigger conditions, delivery endpoints,\nor notification formatting. Modify your real-time blockchain notification settings to adapt\nto changing application requirements without service interruption.\n" }, { "info": { "name": "Toggle a webhook on or off.", "type": "http" }, "http": { "method": "PATCH", "url": "https://mainnet.helius-rpc.com/v0/webhooks/:webhookID", "params": [ { "name": "webhookID", "value": "", "type": "path", "description": "The webhook ID — a UUIDv4 that uniquely identifies the webhook." }, { "name": "api-key", "value": "", "type": "query", "description": "Helius API key. Obtain from https://dashboard.helius.dev or via `helius signup --json`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable a webhook without deleting it. Use this to re-enable a webhook that\nwas automatically disabled due to a high endpoint failure rate, or to temporarily pause\ndeliveries. After re-enabling, the webhook enters a 24-hour grace period during which it\nwill not be automatically disabled again.\n" }, { "info": { "name": "Deletes a webhook.", "type": "http" }, "http": { "method": "DELETE", "url": "https://mainnet.helius-rpc.com/v0/webhooks/:webhookID", "params": [ { "name": "webhookID", "value": "", "type": "path", "description": "The webhook ID — a UUIDv4 that uniquely identifies the webhook." }, { "name": "api-key", "value": "", "type": "query", "description": "Helius API key. Obtain from https://dashboard.helius.dev or via `helius signup --json`." } ] }, "docs": "Permanently remove a webhook configuration from your account. Immediately stop\nreceiving notifications for the specified webhook trigger conditions and free up\nresources for other webhook configurations.\n" } ] } ], "bundled": true }