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

# Test a webhook

> Send a signed test event to one of your webhooks and report how its receiver responded.

<Accordion title="Details">
  * It is sent now, whether the webhook is active or not.

  * The event is \{"id", "type": "webhook.test", "created\_at", "data": \{"webhook\_id"}}.

  * It is not retried and does not count toward turning the webhook off.

  * **Callers:** an API key, an MCP OAuth token or a Dashboard session.

  * **Permission:** `jobs:read`.

  * **Effect:** Creates or changes something.

  * **Errors:** [`not_found`](/errors#not_found), [`webhook_secret_unreadable`](/errors#webhook_secret_unreadable), [`webhooks_unavailable`](/errors#webhooks_unavailable), and the [errors any request can get](/errors).
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json post /v1/webhooks/{id}/test
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: logins
    x-group: Saved logins
  - name: two_factor
    x-group: 2FA
  - name: login_access
    x-group: Login access
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: files
    x-group: Files
  - name: team
    x-group: Team
paths:
  /v1/webhooks/{id}/test:
    post:
      tags:
        - webhooks
      summary: Test a webhook
      description: >-
        Send a signed test event to one of your webhooks and report how its
        receiver responded.
      operationId: webhooks.test
      parameters:
        - name: id
          in: path
          required: true
          description: 'a webhook ID: wh_ and 32 lowercase hex digits'
          schema:
            type: string
            examples:
              - wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
      responses:
        '200':
          description: How the receiver answered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResult'
        '400':
          description: invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: webhooks_unavailable, forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: webhook_secret_unreadable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    WebhookTestResult:
      type: object
      required:
        - delivered
        - status
        - failure
      properties:
        delivered:
          type: boolean
          description: The receiver answered with a 2xx
        status:
          anyOf:
            - $ref: '#/components/schemas/Int'
            - type: 'null'
          description: The receiver's HTTP status, or null when none answered
        failure:
          anyOf:
            - type: string
              enum:
                - invalid_url
                - forbidden_address
                - timeout
                - unreachable
            - type: 'null'
          description: >-
            Why no receiver answered: forbidden_address when the URL resolves to
            a private address, timeout after 10 seconds, or unreachable
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
    Int:
      type: integer
      description: an integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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