Skip to main content
POST
/
v1
/
account
/
{accountSlug}
/
project
/
{projectSlug}
/
alert
curl --request POST \ --url https://api.tenderly.co/api/v1/account/{accountSlug}/project/{projectSlug}/alert \ --header 'Content-Type: application/json' \ --header 'X-Access-Key: <api-key>' \ --data ' { "name": "Successful transaction in My new contract name", "color": "#33d9b2", "description": "", "simple_type": "successful_tx", "enabled": true, "expressions": [ { "type": "contract_address", "expression": { "address": "0x94c87a7b26980ae7aaa361c5c7e03e632ab36e6c" } }, { "type": "network", "expression": { "network_id": "1" } }, { "type": "tx_status", "expression": { "transaction_success": true } } ], "delivery_channels": [ { "enabled": true, "id": "b16b4b75-e034-44c9-a053-f10d769a1d64" }, { "enabled": true, "id": "f48f1f9f-1f74-4849-81cf-fce8bd3746b7" } ] } '
{
  "alert": {
    "id": "d5d5c416-99df-4655-b45c-1e8652f619fa",
    "project_id": "dfdc391a-a15d-4590-9aef-8691259c7df4",
    "name": "Successful transaction in My new contract name",
    "enabled": true,
    "color": "#eeeeee",
    "severity": "default",
    "created_at": "2023-12-13T00:42:34.259670388Z",
    "updated_at": "2023-12-13T00:42:34.259670468Z",
    "is_editable": true,
    "expressions": [
      {
        "line_number": 123,
        "expression": {
          "line_number": 123
        }
      }
    ],
    "description": "This alert tracks successful transactions on Mainnet",
    "delivery_channels": [
      {
        "delivery_channel_id": "b16b4b75-e034-44c9-a053-f10d769a1d64",
        "enabled": true,
        "created_at": "2023-12-13T00:42:34.324117958Z"
      }
    ]
  }
}

Authorizations

​
X-Access-Key
string
header
required

An API key is a token that a client provides when making API calls. The key can be sent as a request header:

curl 'https://api.tenderly.co/api/v1/account/${TENDERLY_ACCOUNT_SLUG}/project/${TENDERLY_PROJECT_SLUG}/simulate' \
  -H 'X-Access-Key: ${TENDERLY_ACCESS_KEY}' \
  ...

Learn how to generate API access tokens at Tenderly Docs.

Path Parameters

​
accountSlug
string
required

Account slug of the user

​
projectSlug
string
required

Project slug of the account

Body

application/json

Create alert payload

​
name
string
required

A name of the alert.

Example:

"Failed transaction in Contract XYZ"

​
simple_type
enum<string>
required

Alert type.

Available options:
successful_tx,
failed_tx,
allowlisted_callers,
blocklisted_callers,
log_emitted,
erc20_transfer_log_emitted,
emitted_log_parameter,
function_called,
called_function_parameter,
state_change,
eth_balance,
tx_value,
view_function
Example:

"failed_tx"

​
expressions
expressions · object[]
required

List of conditions that trigger the alert when met

Defines a specific condition to monitor on the blockchain

Example:
[
  {
    "type": "contract_address",
    "expression": {
      "address": "0x94c87a7b26980ae7aaa361c5c7e03e632ab36e6c"
    }
  },
  {
    "type": "network",
    "expression": { "network_id": "1" }
  },
  {
    "type": "tx_status",
    "expression": { "transaction_success": false }
  }
]
​
delivery_channels
delivery_channels · object[]
required

List of notification channels where alerts will be sent

Example:
[
  {
    "enabled": true,
    "id": "b16b4b75-e034-44c9-a053-f10d769a1d64"
  },
  {
    "enabled": true,
    "id": "f48f1f9f-1f74-4849-81cf-fce8bd3746b7"
  }
]
​
description
string

Alert description.

Example:

"This alert tracks failed transactions on Mainnet"

​
color
enum<string>

Hex color indicating the severity of the alert. It can be one of the following severity types:

  • Default: #eeeeee
  • Info: #34ace0
  • Warning: #ffda79
  • Danger: #ff5252
  • Success: #33d9b2
Available options:
#eeeeee,
#34ace0,
#ffda79,
#ff5252,
#33d9b2
Example:

"#eeeeee"

​
enabled
boolean

Whether the alert is currently active and monitoring

Example:

true

Response

A successful response.

Extended alert information returned by the API

​
alert
alert · object
required

Alert object containing all details of the created alert