---
title: "Webhook example data"
method: GET
path: "/webhooks/sample"
tags: ["webhooks"]
---

# Webhook example data

`GET /webhooks/sample`

## Request

- Base URL: `https://cyber-risk.upguard.com/api/public`
- URL: `https://cyber-risk.upguard.com/api/public/webhooks/sample`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/webhooks/sample/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the example data for one or more notification types.

Required API key permissions: `Admin` (select when creating API key in Account Settings)

## Query parameters

- `id` string
- `notification_type_ids` string[]

## Response `200`

List of example data

- WebhookSampleData[]
  - `context` object: Extra metadata available for the notifications
  - `description` string: Description of the notifications
  - `occurredAt` string, date-time: Timestamp for the event occurrence
  - `type` string: Human readable type of notification

## Other responses

- `403`: Your API key does not have permission to perform this action.
- `429`: Too many requests have been made to this endpoint.
- `500`: An internal system error occurred

---

[API](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api.md) - [All operations](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/revisions/d044bf6dc61e?raw)