This is an archived copy of the APImetrics documentation. For current docs, visit docs.apicontext.com/guides/alerting/using-webhooks/conformance-results-webhook
Guides

Conformance Results Webhook

You can send an alert for every API call you make, or just those that have failed or generated a warning

If you'd like to send conformance findings to another platform, you can use our conformance webhooks to receive alerts on API call 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.

See details on conformance checks here: https://docs.apimetrics.io/docs/conformance

Updated about 1 year ago