Create a webhook

Create a new webhook.

POST /v1/webhooks

Try it

JavaScript

JavaScript

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche();

async function run() {
  const result = await avalanche.webhooks.create({
    eventType: "address_activity",
    url: "https://sophisticated-exterior.org/",
    chainId: "<id>",
    metadata: {
      eventSignatures: [
        "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64",
      ],
      addresses: [
        "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
      ],
    },
  });

  console.log(result);
}

run();

201

{
  "id": "<string>",
  "url": "<string>",
  "chainId": "<string>",
  "status": "active",
  "createdAt": 123,
  "name": "<string>",
  "description": "<string>",
  "eventType": "address_activity",
  "metadata": {
    "addresses": [
      "<string>"
    ],
    "eventSignatures": [
      "<string>"
    ]
  },
  "includeInternalTxs": true,
  "includeLogs": true
}

Authorizations

x-glacier-api-key · string · header · required

Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.

Body

application/json

Option 1

eventType · enum<string> · required

Available options: address_activity

url · string · required

chainId · string · required

metadata · object · required

Show child attributes

metadata. addresses · string[] · required

Ethereum address(es) for the address_activity event type. The maximum number of 'addresses' you can track depends on the Data API plan you are subscribed to.

metadata. eventSignatures · string[]

Array of hexadecimal strings of the event signatures.

name · string

description · string

includeInternalTxs · boolean

Whether to include traces in the webhook payload. Traces are only available for C-Chain on chainId 43113 and 43114.

includeLogs · boolean

Whether to include logs in the webhook payload.

Response

201

application/json

Successful response

Option 1

id · string · required

url · string · required

chainId · string · required

status · enum<string> · required

Available options: active, inactive

createdAt · number · required

name · string · required

description · string · required

eventType · enum<string> · required

Available options: address_activity

metadata · object · required

Show child attributes

metadata. addresses · string[] · required

Ethereum address(es) for the address_activity event type. The maximum number of 'addresses' you can track depends on the Data API plan you are subscribed to.

metadata. eventSignatures · string[]

Array of hexadecimal strings of the event signatures.

includeInternalTxs · boolean

Whether to include traces in the webhook payload.

includeLogs · boolean

Whether to include logs in the webhook payload.