> ## Documentation Index
> Fetch the complete documentation index at: https://docs.igrisecurity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send a test alert

> Sends a test `anomaly` alert to the webhook.

<Note>
`success: true` means the test alert was sent. It does not mean your endpoint received or accepted it. Delivery errors and non-2xx responses from your endpoint are not reported. `success: false` is returned only when the stored webhook cannot be decrypted.
</Note>

**Required permission:** `alerts:manage`




## OpenAPI

````yaml /api-reference/openapi.yaml post /api/v1/webhooks/{id}/test
openapi: 3.1.0
info:
  title: Igris Management API
  version: '1'
  description: >-
    REST API for managing Igris connections, policies, sessions, audit events
    and alerts.
servers:
  - url: https://api.igrisecurity.com
security:
  - bearerAuth: []
tags:
  - name: Connections
  - name: Policies
  - name: Sessions
  - name: Audit Events
  - name: Incidents
  - name: Webhooks
  - name: API Keys
  - name: Members
  - name: LLM Providers
  - name: LLM Cost
  - name: Observe
paths:
  /api/v1/webhooks/{id}/test:
    post:
      tags:
        - Webhooks
      summary: Send a test alert
      description: >
        Sends a test `anomaly` alert to the webhook.


        <Note>

        `success: true` means the test alert was sent. It does not mean your
        endpoint received or accepted it. Delivery errors and non-2xx responses
        from your endpoint are not reported. `success: false` is returned only
        when the stored webhook cannot be decrypted.

        </Note>


        **Required permission:** `alerts:manage`
      operationId: testWebhook
      parameters:
        - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: The test result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      error:
                        type: string
                        description: Present when `success` is false.
              example:
                data:
                  success: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  responses:
    Unauthorized:
      description: No valid session or API key, or the key's creator is no longer a member.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
    Forbidden:
      description: The caller lacks the required permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    NotFound:
      description: Not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not found
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          example: Forbidden
        required:
          type: string
          description: The permission the caller lacks.
          example: policies:write
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ig_...
      description: >-
        An Igris API key. It acts with the current role and permission overrides
        of the member who created it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.