# Heartbeat

At the end of each of Airnode's runs (every minute), Airnode can make an HTTP POST request to a specified URL. This is both to signal that the Airnode is alive and working (useful especially right after the deployment) and also to send some metrics from its run.

Heartbeat (optional)

Using the heartbeat functionality with Airnode is optional.

Turn on the optional heartbeat functionality by setting all fields in the config.json section nodeSettings.heartbeat.

{
  ois:{...},
  triggers:{...},
  chains:{...},
  environment:{...},
  nodeSettings:{
      "nodeVersion": "0.2.2",
      "cloudProvider": "aws",
      "region": "us-east-1",
      "stage": "testnet",
      "airnodeWalletMnemonic": "<FILL_*>",
      "heartbeat": {
        "enabled": true,
        "url": "${HEARTBEAT_URL}",
        "apiKey": "${HEARTBEAT_API_KEY}",
        "id": "${HEARTBEAT_ID}"
      },
      "httpGateway": {
        "enabled": true,
        "apiKey": "${HTTP_GATEWAY_API_KEY}"
      },
      "logFormat": "json",
      "logLevel": "INFO"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

enabled: Enable/disable Airnode's heartbeat
url: The URL to make the heartbeat request to
apiKey: The API key to authenticate against the heartbeat URL
id: The Airnode heartbeat ID for accounting purposes

# Heartbeat Endpoint

Every time an HTTP POST request is made against the heartbeat endpoint declared with nodeSettings.heartbeat.url, the following parameters are passed:

name	in	type
api_key	body	string
deployment_id	body	string
http_gateway_url	body	string
payload	body	json

Below is an example of what is included in the request to heartbeat.url.

{
  "api_key":"d714a900-3b9e-4e4d-8eae-756ef06a8836",
  "deployment_id":"916d3ec80fda",
  "http_gateway_url":"https://some.aws.api.gateway.url/v1/test",
  "payload":{...}
}

1
2
3
4
5
6

api_key:	API key for heartbeat calls configured in nodeSettings.heartbeat.apiKey. Used for authentication against the heartbeat service running on URL from nodeSettings.heartbeat.url.
deployment_id:	The Airnode heartbeat ID for accounting purposes.
http_gateway_url:	If HTTP gateway is enabled this is the URL of the gateway you can make test HTTP calls against.
payload:	Metrics from Airnode's run.

← Applying Authorization (optional) HTTP Gateway (optional) →