---
title: "This endpoint is used to test a webhook."
method: POST
path: "/notifications/webhook/test"
tags: ["Webhook Notifications"]
---

# This endpoint is used to test a webhook.

`POST /notifications/webhook/test`

## Request

- Base URL: `https://console.jumpcloud.com/api/v2`
- URL: `https://console.jumpcloud.com/api/v2/notifications/webhook/test`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/docs/notifications/webhook/test/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows you to test a webhook.

## Request body

- JumpcloudNotificationsWebhookTestRequest
  - `organizationObjectId` string, byte
  - `postSave` JumpcloudNotificationsPostSaveWebhookRequest: PostSaveWebhookRequest represents the request to test a webhook after saving.
    - `authPassword` string
    - `authToken` string
    - `authType` 'WEBHOOK_AUTH_TYPE_UNSPECIFIED' | 'WEBHOOK_AUTH_TYPE_BASIC' | 'WEBHOOK_AUTH_TYPE_BEARER': WebhookAuthType represents the authentication type for the webhook. - WEBHOOK_AUTH_TYPE_UNSPECIFIED: WEBHOOK_AUTH_TYPE_UNSPECIFIED represents an invalid authentication type. - WEBHOOK_AUTH_TYPE_BASIC: WEBHOOK_AUTH_TYPE_BASIC represents basic authentication. - WEBHOOK_AUTH_TYPE_BEARER: WEBHOOK_AUTH_TYPE_BEARER represents bearer token authentication.
    - `authUsername` string
    - `customHeaders` JumpcloudNotificationsCustomHeaders[]
      - `key` string
      - `masked` boolean
      - `objectId` string, byte
      - `value` string
    - `maskedUrlPortion` JumpcloudNotificationsMaskedURLPortion[]
      - `key` string
      - `objectId` string, byte
      - `value` string
    - `objectId` string, byte
    - `sslVerification` boolean
    - `url` string
    - `urlMasked` boolean
  - `preSave` JumpcloudNotificationsPreSaveWebhookRequest: PreSaveWebhookRequest represents the request to test a webhook before saving.
    - `authPassword` string
    - `authToken` string
    - `authType` 'WEBHOOK_AUTH_TYPE_UNSPECIFIED' | 'WEBHOOK_AUTH_TYPE_BASIC' | 'WEBHOOK_AUTH_TYPE_BEARER': WebhookAuthType represents the authentication type for the webhook. - WEBHOOK_AUTH_TYPE_UNSPECIFIED: WEBHOOK_AUTH_TYPE_UNSPECIFIED represents an invalid authentication type. - WEBHOOK_AUTH_TYPE_BASIC: WEBHOOK_AUTH_TYPE_BASIC represents basic authentication. - WEBHOOK_AUTH_TYPE_BEARER: WEBHOOK_AUTH_TYPE_BEARER represents bearer token authentication.
    - `authUsername` string
    - `customHeaders` JumpcloudNotificationsCustomHeaders[]
      - `key` string
      - `masked` boolean
      - `objectId` string, byte
      - `value` string
    - `sslVerification` boolean
    - `url` string
    - `urlMasked` boolean

## Response `200`

A successful response.

- JumpcloudNotificationsWebhookTestResponse
  - `responseMessage` string
  - `statusCode` integer

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/revisions/3f09fe63caaa?raw)