Create a webhook

POST

webhooks

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  chainId: "43114",
  network: "mainnet",
});

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

  // Handle the result
  console.log(result);
}

run();

{
  "id": "<string>",
  "eventType": "address_activity",
  "url": "<string>",
  "chainId": "<string>",
  "status": "active",
  "createdAt": 123,
  "name": "<string>",
  "description": "<string>",
  "metadata": {
    "addresses": {
      "0": "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"
    },
    "eventSignatures": {
      "0": "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"
    }
  },
  "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

eventType

enum<string>

required

Available options:

address_activity

url

string

required

chainId

string

required

metadata

object

required

metadata.addresses

string[]

required

Ethereum address(es) for the address_activity event type

Example:

[
  "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"
]

metadata.eventSignatures

string[]

Array of hexadecimal strings of the event signatures.

Example:

[
  "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"
]

network

enum<string>

Available options:

mainnet,

fuji

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.

eventType

enum<string>

required

Available options:

address_activity

url

string

required

chainId

string

required

metadata

object

required

metadata.addresses

string[]

required

Ethereum address(es) for the address_activity event type

Example:

[
  "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"
]

metadata.eventSignatures

string[]

Array of hexadecimal strings of the event signatures.

Example:

[
  "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"
]

network

enum<string>

Available options:

mainnet,

fuji

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.

eventType

enum<string>

required

Available options:

platform_address_activity,

validator_activity

url

string

required

chainId

string

required

metadata

object

required

Metadata for platform activity

metadata.keyType

enum<string>

required

The type of key for platform activity depending on the event type

Available options:

addresses,

nodeId,

subnetId

metadata.keys

string[]

required

Array of keys like addresses, NodeID or SubnetID corresponding to the keyType being monitored. For PlatformAddressActivity event, an array of multiple addresses can be provided. ValidatorActivity event will only accept a single key

metadata.subEvents

object

Sub-events to monitor

metadata.eventSignatures

string[]

Array of hexadecimal strings of the event signatures.

Example:

{
  "0": "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"
}

metadata.nodeIds

string[]

Array of node IDs to filter the events

metadata.subnetIds

string[]

Array of subnet IDs to filter the events

metadata.balanceThresholdFilter

object

Balance threshold filter

metadata.l1ValidatorFeeBalanceThreshold

string

L1 validator fee balance threshold in nAVAX

network

enum<string>

Available options:

mainnet,

fuji

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

string

required

eventType

enum<string>

required

Available options:

address_activity,

platform_address_activity,

validator_activity

url

string

required

chainId

string

required

status

enum<string>

required

Available options:

active,

inactive

createdAt

number

required

name

string

required

description

string

required

metadata

object

required

metadata.addresses

string[]

required

Ethereum address(es) for the address_activity event type

Example:

{
  "0": "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"
}

metadata.eventSignatures

string[]

Array of hexadecimal strings of the event signatures.

Example:

{
  "0": "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"
}

includeInternalTxs

boolean

Whether to include traces in the webhook payload.

includeLogs

boolean

Whether to include logs in the webhook payload.

string

required

eventType

enum<string>

required

Available options:

address_activity,

platform_address_activity,

validator_activity

url

string

required

chainId

string

required

status

enum<string>

required

Available options:

active,

inactive

createdAt

number

required

name

string

required

description

string

required

metadata

object

required

metadata.addresses

string[]

required

Ethereum address(es) for the address_activity event type

Example:

{
  "0": "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"
}

metadata.eventSignatures

string[]

Array of hexadecimal strings of the event signatures.

Example:

{
  "0": "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"
}

includeInternalTxs

boolean

Whether to include traces in the webhook payload.

includeLogs

boolean

Whether to include logs in the webhook payload.

string

required

eventType

enum<string>

required

Available options:

address_activity,

platform_address_activity,

validator_activity

url

string

required

chainId

string

required

status

enum<string>

required

Available options:

active,

inactive

createdAt

number

required

name

string

required

description

string

required

metadata

object

required

metadata.keyType

enum<string>

required

The type of key for platform activity depending on the event type

Available options:

addresses,

nodeId,

subnetId

metadata.keys

string[]

required

metadata.subEvents

object

Sub-events to monitor

metadata.eventSignatures

string[]

Array of hexadecimal strings of the event signatures.

Example:

{
  "0": "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"
}

metadata.nodeIds

string[]

Array of node IDs to filter the events

metadata.subnetIds

string[]

Array of subnet IDs to filter the events

metadata.balanceThresholdFilter

object

Balance threshold filter

metadata.l1ValidatorFeeBalanceThreshold

string

L1 validator fee balance threshold in nAVAX

Was this page helpful?

List webhooks Get a webhook by ID

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  chainId: "43114",
  network: "mainnet",
});

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

  // Handle the result
  console.log(result);
}

run();

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

Get Started

Platform Webhooks(BETA)

Tutorials

API Reference

Authorizations

Body

Response