Webhook Specification

The webhook notification type can send a webhook to the URL of your choosing. Webhooks are sent as a POST request containing a JSON payload. Below is the shape of an example webhook:

{
api: {
id: '[INTERNAL API ID]',
name: '[Name of API which triggered incident e.g. GitHub]'
},
incident: {
id: '[INTERNAL INCIDENT ID]',
started_at: 1579540568, // Starting Timestamp
completed_at: 1579540868, // Ending Timestamp
complete: true,
link: 'https://app.bearer.sh/incidents'
},
rule: {
id: '[INTERNAL RULE ID]',
name: '[Name of incident rule e.g. My Rule]',
description: 'Consumption for API calls reaches 1 call over 5 mins',
metric: 'request_count',
call_type: 'api',
comparison: 'value_up',
threshold: 1,
threshold_units: 'calls',
period_in_mins: 5,
link: 'https://app.bearer.sh/rules'
},
app: {
id: '[INTERNAL APP ID]',
name: 'My App' // Name of the affected application
},
environment: {
name: '[Environment in which incident occurred]'
}
}