Create a heartbeat endpoint configuration

post

https://api.firehydrant.io/v1/signals/heartbeat_endpoints

Create a new heartbeat endpoint configuration for your organization

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a new heartbeat endpoint configuration for your organization

slug

string

required

Unique URL path segment for the heartbeat endpoint

enabled

boolean

required

Whether the endpoint is active

description

string | null

Optional description of the endpoint's purpose

expect_interval

string

required

Time interval in which heartbeats are expected (minimum '5m', maximum '24h')

template_signal

object

required

Signal template to be used when generating alerts for missed heartbeats

kind

string

enum

required

Type of heartbeat endpoint (e.g. 'http')

Allowed:

allowed_http_methods

array of strings | null

HTTP methods allowed for this endpoint

allowed_http_methods

allowed_user_agent_substring

string | null

User agent substring that must be present in requests

allowed_email_senders

array of strings | null

Email addresses allowed to send heartbeats

allowed_email_senders

Response

201

Create a new heartbeat endpoint configuration for your organization

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!