Skip to main content
Webhooks let Flarehawk send alert data as an HTTP POST request to any HTTPS endpoint you control. When a detection rule fires an alert, Flarehawk delivers a structured JSON payload to your endpoint — immediately and without polling. This makes webhooks the right choice for connecting Flarehawk to incident management tools like PagerDuty and incident.io, or to a custom pipeline you build yourself.

Adding a webhook endpoint

1

Open notification settings

In the Flarehawk dashboard, navigate to Settings and click the Notifications tab.
2

Enable the webhook channel

Toggle the webhook channel on.
3

Enter your endpoint URL

Paste the HTTPS URL of your endpoint in the Webhook URL field. The URL must be publicly reachable — private IP addresses, localhost, and internal hostnames are rejected.
4

Add custom headers (optional)

If your endpoint requires authentication, add headers such as Authorization: Bearer <your-token> in the Custom headers section. These headers are sent with every webhook request.
5

Save and test

Click Save, then send a test notification to confirm your endpoint receives the payload.
Only organization admins can configure webhook endpoints.

Payload format

Flarehawk sends a POST request with Content-Type: application/json and the following payload structure. All fields are present on every delivery; optional fields that have no value are omitted.

Event types

The event_type field tells you what triggered the notification:

Severity values

The severity field is one of low, medium, high, or critical.

Webhook delivery and retries

Flarehawk considers a delivery successful when your endpoint returns a 2xx HTTP status code. If your endpoint returns any other status code or does not respond, Flarehawk retries the delivery automatically. Deliveries that fail after all retries are recorded but not re-queued indefinitely. To minimize failed deliveries:
  • Ensure your endpoint responds within a reasonable timeout.
  • Return 200 OK as quickly as possible. If you need to process the payload asynchronously, acknowledge receipt immediately and process in the background.
  • Avoid returning 5xx errors transiently — they consume retry attempts.
Test your endpoint response handling with the test notification in Settings → Notifications before relying on it for production alerts.

Custom headers

You can add any HTTP request headers to webhook deliveries in the Custom headers field in Settings → Notifications. Headers are useful for authentication tokens, routing keys, or content negotiation. For example:
Do not include headers that control transport behavior (Host, Cookie, Transfer-Encoding, Content-Length, Connection). Flarehawk strips these for security reasons and they will not be sent.

Provider-specific formatting

Flarehawk automatically detects certain well-known webhook destinations and reformats the payload for their native API:

Common integrations

Use your PagerDuty Events API v2 integration URL as the webhook endpoint. Flarehawk automatically formats the payload for PagerDuty, mapping incident_created and incident_escalated to trigger events and incident_resolved to a resolve event. The dedup_key is set to flarehawk-{incident_id} so PagerDuty correctly correlates resolution events with the original incident.In PagerDuty, create a service with an Events API v2 integration and copy the endpoint URL into Flarehawk’s webhook settings.
Create an Incoming webhook alert source in incident.io and paste the generated URL into Flarehawk’s webhook settings. Use the standard Flarehawk payload — incident.io accepts generic JSON and lets you map fields to its alert schema in the alert source configuration.
Any publicly reachable HTTPS endpoint works as a Flarehawk webhook destination. Your handler receives a POST request with Content-Type: application/json. Use the Authorization custom header to authenticate requests. Respond with 200 OK to acknowledge receipt.

Testing your webhook

Send a test delivery at any time from Settings → Notifications. The test sends a sample incident_created payload to your configured endpoint using the same delivery path as real alerts. Check your endpoint’s logs or response for confirmation.
Test payloads use synthetic data and do not correspond to real incidents. They are intended only to verify that your endpoint is reachable and that Flarehawk’s configuration is correct.