Default Webhook Template and Supported Keys

When you configure a webhook service but do not provide a custom template, Infoblox Platform uses the following default template to generate payload for your notifications. For information about how to configure webhook services, see Configuring Webhook Services.

{

"id":"{{ .id}}",

"type":"{{ .type}}",

"subtype":"{{ .subtype}}",

"account_id":"{{ .account_id}}",

"occurred_time": "{{ .occurred_time}}",

"generated_time": "{{ .generated_time}}",

"severity": "{{ .severity}}",

"short_subject": "{{ .short_subject}}",

"message": "{{ .message}}",

"url": "{{ .url}}",

"preferences_url": "https://{{ .csphost}}/{{.userPreferencesPath}}"

}

The following table describes the supported fields in the default webhook template:

Supported Fields	Description
`id`	An auto-generated ID for the event
`type`	Event type such as "`ACCOUNT`"
`subtype`	Event sub type such as "`license_expiration`" for event type "`ACCOUNT"`
`account_id`	The account ID
`severity`	Severity of the generated event: Low, Medium, and High
`metadata`	Metadata associated with the event
`occurred_time`	The timestamp when the event occurred
`generated_time`	The timestamp when the notification was generated
`short_subject`	A brief description of the event. Example: `"Host Memory Usage Limit Exceeded"`
`message`	The message of the event. Example: `"Internal error occurred. For more details see log for request 1a94821f-0f7a-48ab-b1cf-b137d628afd4"`
`url`	The URL to which you want to send webhook notifications
`preferences_url`	A link to the "View all notifications” page on the Infoblox Portal
`actionable_redirect_action`	The actionable redirect URL. This must appear in the webhook context in order for the template to pick up.
`actionable_redirect_label`	This is optional. This is the text for the actionable redirect URL link. If this is missing, the system uses the actionable redirect URL.

Other Supported Fields

Apart from the fields in the default webhook template, other fields are also supported.

The following fields are supported for the following alerts:

DHCP range utilization below low threshold
DHCP range utilization above high threshold

Supported Fields	Description
range_id	ID for the range. For e.g /ipam/range/fa42b963-6d2d-11ee-89f6-aa8883d81554
range_name	Name of the range
range_start	Start address for the range
range_end	End address for the range
range_space_name	Name of the IP space.
range_high_threshold	High threshold for DHCP utilization (%)
range_low_threshold	Low threshold for DHCP utilization (%)
range_utilization	Current DHCP utilization %