webhooks

Create a new webhook

Create a new webhook subscribing to the provided list of notifications.

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

post/webhooks

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/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

namestring required

The name given to the webhook

hook_urlstring required

The URL used for sending notifications

notification_type_idsstring[] required

The list of notifications to subscribe to. For a list of supported notification types and their IDs use the /api/public/webhooks/notification_types endpoint.

webhook_type'webhook' | 'workflow_webhook'

The type of webhook to create

Response

Information about the created webhook

idstring

The ID of the created webhook

signing_secretstring

The HMAC signing secret for webhook authentication (hex-encoded, 64 characters). This is only returned once on creation. Webhooks will include an X-UpGuard-Signature header using this secret for authentication.

Example response

{
  "id": "ABCD1234",
  "signing_secret": "a1b2c3d4e5f67890123456789012345678901234567890123456789012345678"
}

Changes

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