⚡ Heavy Workload? We Offer Higher Rate Limits to Accelerate Your dApp Performance

bg pattern bg pattern xs
/

Endpoints

POST

Create

Create a webhook

  • https://api.getblock.io/external/webhook/

Request

Headers

  • x-api-key string - GetBlock API key to access GetBlock Tracker API.

Body

Object

  • name string - webhook name.

  • expression string - boolean expression to trigger the webhook.

  • url string - your target URL to receive webhook notifications.

  • protocol string - protocol of the node (BNB Smart chain).

  • network string - network of the node (mainnet).

  • draft bool - true, if the webhook is draft, false – if not.

  • enabled bool - true, if the webhook is enabled, false – if not.

Response

Response successful [200]

Array of objects

  • id string - webhook id.

  • name string - webhook name.

  • expression string - boolean expression to trigger the webhook.

  • url string - your target URL to receive webhook notifications.

  • protocol string - protocol of the node (BNB Smart chain).

  • network string - network of the node (mainnet).

  • draft bool - true, if the webhook is draft, false – if not.

  • enabled bool - true, if the webhook is enabled, false – if not.

  • failed bool - true, if URL of the webhook doesn’t work (status code is not 200 or smt).

Response not successful [400, 500]

Object

  • description string - description of what went wrong.

  • status_code int - status code of the response.

Examples

Request

curl --location --request POST 'https://api.getblock.io/external/webhook/' \
--header 'x-api-key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '
{
  "name": "some name",
  "expression": "block_number > 1",
  "url": "https://webhook.site/"
  "network": "mainnet",
  "enabled": true,
  "protocol": "bsc"
}'

Response

{
    "id": "374173824",
    "name": "some name",
    "expression": "block_number > 1",
    "url": "https://webhook.site/",
    "protocol": "bsc",
    "network": "mainnet"
    "draft": false,
    "enabled": true,
    "failed": false
}