webhooks

Webhook example data

Get the example data for one or more notification types.

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

get/webhooks/sample

Request

Base URL
https://cyber-risk.upguard.com/api/public
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.

Query parameters

idstring

The ID of a webhook. If specified sample data for all the notification types registered for that webhook will be returned.

notification_type_idsstring[]

A list of notification type IDs you need sample data for. If a webhook ID is provided this parameter is ignored.

Response

List of example data

contextobject

Extra metadata available for the notifications

descriptionstring

Description of the notifications

occurredAtstring date-time

Timestamp for the event occurrence

typestring

Human readable type of notification

Example response

[
  {
    "description": "Jane Doe replied to a message by John Smith on questionnaire 'SOC2'",
    "occurredAt": "2021-08-17T23:04:02Z",
    "type": "QuestionnaireCorrespondence"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.