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

# Send a test event to a webhook endpoint

> Relays the customer endpoint's response: the HTTP status mirrors theirs, and the body (httpStatus, latencyMs, success, error) reports the outcome. A 4xx/5xx means their endpoint responded that way, not that this API failed.



## OpenAPI

````yaml https://api.gonitro.dev/openapi.json post /webhooks/configs/test
openapi: 3.1.0
info:
  title: Nitro Sign Public API
  description: REST API for Nitro Sign
  version: '0.1'
servers:
  - url: https://api.gonitro.dev
    description: Europe
  - url: https://api.us.gonitro.dev
    description: North America
  - url: https://api.au.gonitro.dev
    description: Australia
security:
  - bearerAuth: []
paths:
  /webhooks/configs/test:
    post:
      tags:
        - Webhooks
      summary: Send a test event to a webhook endpoint
      description: >-
        Relays the customer endpoint's response: the HTTP status mirrors theirs,
        and the body (httpStatus, latencyMs, success, error) reports the
        outcome. A 4xx/5xx means their endpoint responded that way, not that
        this API failed.
      operationId: test
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookTestRequest'
        required: true
      responses:
        '200':
          description: Endpoint returned 2xx.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
        '400':
          description: Invalid request (e.g. malformed URL).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestProblemDetail'
        '401':
          description: Unauthorized - Invalid or missing JWT token
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/UnauthorizedProblemDetail'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ForbiddenProblemDetail'
        '502':
          description: Endpoint unreachable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
        4XX:
          description: Endpoint rejected the event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
        5XX:
          description: Endpoint errored.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
components:
  schemas:
    WebhookTestRequest:
      type: object
      properties:
        url:
          type: string
          description: The customer endpoint URL to send a synthetic test event to
          example: https://customer.example.com/webhook
          minLength: 1
      required:
        - url
    WebhookTestResponse:
      type: object
      properties:
        httpStatus:
          type: integer
          format: int32
          description: HTTP status returned by the customer endpoint, if any
          example: 200
        latencyMs:
          type: integer
          format: int64
          description: Round-trip latency in milliseconds
          example: 87
        success:
          type: boolean
          description: Whether the customer endpoint returned a 2xx response
          example: true
        error:
          type: string
          description: Network-level error when no HTTP response was received
          example: Connection refused
    BadRequestProblemDetail:
      type: object
      description: Bad Request error details
      example:
        type: https://developers.gonitro.com/docs/build-nitro/errors#400-bad-request
        title: Bad Request
        status: 400
        detail: Request validation failed
        instance: /sign/envelopes
        validation_errors:
          name: must not be blank
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          format: int32
          description: The HTTP status code
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence
        extensions:
          type: object
          additionalProperties: {}
          description: Additional problem-specific properties
    UnauthorizedProblemDetail:
      type: object
      description: Unauthorized error details
      example:
        type: >-
          https://developers.gonitro.com/docs/build-nitro/errors#401-unauthorized
        title: Unauthorized
        status: 401
        detail: Missing or invalid Authorization header
        instance: /sign/envelopes
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          format: int32
          description: The HTTP status code
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence
        extensions:
          type: object
          additionalProperties: {}
          description: Additional problem-specific properties
    ForbiddenProblemDetail:
      type: object
      description: Forbidden error details
      example:
        type: https://developers.gonitro.com/docs/build-nitro/errors#403-forbidden
        title: Forbidden
        status: 403
        detail: Forbidden
        instance: /webhooks/configs
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          format: int32
          description: The HTTP status code
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence
        extensions:
          type: object
          additionalProperties: {}
          description: Additional problem-specific properties
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````