Create Webhook

Programatically create a Helius webhook.

Note: It may take up to 2 minutes for webhook changes to take effect!

POST /webhooks

Creates a webhook given account addresses, transaction types, and a webhook URL. You can optionally provide an authorization header to verify that the webhook came from Helius.

Important! For a full list of supported transactionTypes —please see Transaction Types

If you'd like a raw transaction payload instead of our enhanced transaction object, please input "raw" for the webhookType. If you'd like the enhanced version, input "enhanced". Note that raw transactions have much lower latencies due to us not parsing the event types.

Creates a webhook.

POSThttps://api.helius.xyz/v0/webhooks

Query parameters

Body

application/json

webhookURLstring

transactionTypesarray of TransactionType (enum)

accountAddressesarray of string

webhookTypestring

authHeaderstring

Response

200

The created webhook.

Body

application/json

webhookIDstring

walletstring

webhookURLstring

transactionTypesarray of TransactionType (enum)

accountAddressesarray of string

webhookTypestring

authHeaderstring

Request

JavaScriptCurl

const response = await fetch('https://api.helius.xyz/v0/webhooks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "webhookID": "text",
  "wallet": "text",
  "webhookURL": "text",
  "transactionTypes": [
    "UNKNOWN"
  ],
  "accountAddresses": [
    "text"
  ],
  "webhookType": "text",
  "authHeader": "text"
}

Webhook Types

Raw Transactions (Sample Payload)

{
     "webhookURL": "https://TestServer.test.repl.co/webhooks",
     "transactionTypes": ["Any"],
     // Use ["ACCOUNT_ADDRESS", "ACCOUNT_ADDRESS"] for multiple accountAddresses. 
     "accountAddresses": ["ACCOUNT_ADDRESS"],
     "webhookType": "raw", // "rawDevnet"
     "txnStatus": "all", // success/failed
     "authHeader": "<Optional_AuthHeader>"
}

Enhanced Transactions (Sample Payload)

{
     "webhookURL": "https://TestServer.test.repl.co/webhooks",
     "transactionTypes": ["NFT_SALE"],
     // Use ["ACCOUNT_ADDRESS", "ACCOUNT_ADDRESS"] for multiple accountAddresses. 
     "accountAddresses": ["ACCOUNT_ADDRESS"],
     "webhookType": "enhanced", // "enhancedDevnet"
     "authHeader": "<Optional_AuthHeader>"
}

Discord Transactions (Sample Payload)

{
     "webhookURL": "https://discord.com/api/webhooks/<WebhookID>/<TokenID>",
     "transactionTypes": ["NFT_SALE"],
     // Use ["ACCOUNT_ADDRESS", "ACCOUNT_ADDRESS"] for multiple accountAddresses. 
     "accountAddresses": ["ACCOUNT_ADDRESS"], 
     "webhookType": "discord" // "discordDevnet"
}

Basic Example

const createWebhook = async () => {
    try {
      const response = await fetch(
        "https://api.helius.xyz/v0/webhooks?api-key=<PASTE YOUR API KEY HERE>",
        {
          method: 'POST',
          headers: {
            'Content-Type': 'application/json',
          },
          body: JSON.stringify({
          "webhookURL": "https://TestServer.test.repl.co/webhooks",
          "transactionTypes": ["Any"],
          "accountAddresses": ["2PP32Vmuzgo1UC847Yzdd9CkowXWhMLrJ47Gfr4KDAyN"],
          "webhookType": "raw", // "rawDevnet"
          "txnStatus": "all", // success/failed
       }),
        }
      );
      const data = await response.json();
      console.log({ data });
    } catch (e) {
      console.error("error", e);
    }
  };
  createWebhook();

Testing Environments

Here are some testing environments that are quick to set up for posting webhook events:

Webhook.site - Test, process and transform emails and HTTP requests

Copy URL to use in payload

TypedWebhook.tools: a tool to test webhooks and generate payload types

Copy URL to use in payload