v1

latestOpenAPI 3.0.32026-07-1320201.0 MB

Arbitrum Webhooks

Create webhook

Creates a new webhook for real-time communication and event notification.

post/api/v2/arbitrum/webhooks

Headers

X-Network'testnet' | 'mainnet'

Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.

Authorizationstring required

Bearer token for authorization. Required for authenticated endpoints.

Content-Type'application/json' | 'application/x-www-form-urlencoded' | 'multipart/form-data' required

The MIME type of the request body.

Request body

fromstring

Sender address (required if not "to"). This field is required when <code>to</code> is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.

tostring

Receiver address (required if not providing "from"). This field is required when <code>from</code> is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.

urlstring required

URL for webhook notifications (required). Must be a valid URL.

contractaddressstring

The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of <code>from</code> and <code>to</code> are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.

token_idstring

This field is required when none of <code>from</code> and <code>to</code> are present.

type'ETH' | 'ERC20' | 'ERC721'

referencestring nullable

A reference for the webhook. Must not be greater than 255 characters.

Example request

{
  "from": "0x922815dFbEa128eAeaAAa185508fe078bECeFBBE",
  "to": "0x922815dFbEa128eAeaAAa185508fe078bECeFBBE",
  "url": "http://vonrueden.com/",
  "contractaddress": "0x922815dFbEa128eAeaAAa185508fe078bECeFBBE",
  "type": "ERC20",
  "reference": "n"
}

Response

statusinteger

okboolean

messagestring

Example response

{
  "status": 201,
  "ok": true,
  "message": "Webhook created",
  "data": {
    "webhook": "9b2b4dcc-1479-4bcd-9b8a-015673e80f46"
  }
}