Sign in
Alerts

create an alert hook

Changed on

Adds an external destination that every new alert for the account is pushed to as it happens. An account may have at most 5 alert hooks.

post/Accounts/{AccountSid}/AlertHooks

Request

  • Base URL: https://api.jambonz.cloud/v1
  • URL: https://api.jambonz.cloud/v1/Accounts/{AccountSid}/AlertHooks
  • Auth: HTTP bearer

Path parameters

AccountSidstring uuid required

Request body

type'json' | 'slack' | 'pagerduty' | 'email' required

json - signed JSON POST to a URL; slack - Slack incoming webhook; pagerduty - PagerDuty Events API v2; email - only when the platform has email configured

addressstring required

json and slack - an https URL (a Slack incoming webhook URL for slack); pagerduty - an Events API v2 routing key; email - an email address

Response

alert hook successfully created

sidstring required

Example response

{
  "sid": "9d26a637-1679-471f-8da8-7150266e1254"
}

Changes