Conformance Results Webhook

If you'd like to send conformance findings to another platform, you can use our conformance webhooks to receive alerts on monitor results.

To set it up, you just need to provide us with a URL that is publicly accessible. This could be something as simple as a AWS Lambda or a Google Cloud function.

We use a HTTP POST to send you the following data:

severityNumber: WARN | INFO (warning for failures, info for passes)
severityText: WARN | INFO
body: str: “${category} conformance check ${result}ed"
attributes:
        project_id: string
        timestamp: string
        category: str - category name
        check_name: string
        call_id: string
        result_id: string

Depending on the type of conformance check, there will be additional information.

Categories

The category attribute is one of the following. Security findings are sent only when a check fails; every other category is sent for passes and failures.

`category`	Sent for
`schema`	Schema conformance checks
`security`	Security conformance checks (failures only)
`specification`	Checks against your API specification
`data`	Data conformance checks
`objective`	Objective checks
`threshold`	Threshold checks
`network`	Network conformance checks
`coverage`	Specification coverage

A coverage event also carries metric, coverage, goal, total_calls, missing_calls, total_endpoints, and missing_endpoints. When the goal is missed, it adds missing_call_ids and may add a description.

See details on conformance checks here: Conformance

Categories​

Categories