Skip to main content
POST
/
api
/
v1
/
webhooks
Create webhook subscription
curl --request POST \
  --url https://app.larm.dev/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "url": "https://example.com/webhooks/larm",
    "events": ["monitor.state_changed", "monitor.created"],
    "enabled": true,
    "secret": "a1b2c3d4e5f6...",
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}
Requires monitors:read_write permission.
url
string
required
HTTPS endpoint URL to receive webhook events
events
string[]
required
Events to subscribe to. At least one required. Valid values: monitor.state_changed, monitor.created, monitor.updated, monitor.deleted.
enabled
boolean
default:true
Whether the subscription is active
The response includes the signing secretthis is only shown once. Use it to verify webhook payloads via the X-Larm-Signature header.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "url": "https://example.com/webhooks/larm",
    "events": ["monitor.state_changed", "monitor.created"],
    "enabled": true,
    "secret": "a1b2c3d4e5f6...",
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}