Skip to main content

​
Introduction

The webhook sink delivers Run results to your endpoint via POST request. This is useful for sending results directly to your backend or a third-party service.

​
Usage

Webhook sinks can be used with either the Run API or the Job API. When creating a Run or Job, specify the sink type as webhook and provide the destination url. You can also optionally provide headers to include in the request. See the Configuration section below for full details.

​
Configuration

The webhook sink requires a destination URL. This URL must be publicly accessible. You can optionally add headers to include with each request.

​
Properties

​
type
enum<string>
required
The type of sink.Available options: webhook
​
url
string
required
The destination URL where Intuned sends Run results.Example: https://example.com/webhook
​
headers
object
Headers to include in the request to your endpoint.
​
skipOnFail
boolean
default:"false"
If true, results from failed Runs are not sent.
​
apisToSend
array<string>
List of API names to include. If not provided, results from all APIs are sent.Example: ["api1", "api2"]

​
Example Configuration

{
  // other run/job configuration fields
  ....
  "sink": {
    "type": "webhook",
    "url": "https://example.com/webhook",
    "headers": {
      "Authorization": "Bearer <token>"
    }
  }
}

​
API

​
Request

Intuned sends a POST request to your endpoint with a JSON payload containing the API Run result and additional metadata. See the sink body page for more information on the payload structure.

​
Response

The request is considered successful if your endpoint returns a status code in the 200-299 range. If not, the request is considered a failure and Intuned retries with exponential backoff.