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

# Send a Test Delivery

> Queues one synthetic delivery so an endpoint and its signature check can be verified before a real trigger fires. It uses the same queue, signing and attempt logging as a real delivery; only the body is synthetic, and its `event` is the reserved key `webhook.test`.

**Delivery semantics.** Delivery is at-least-once: the same envelope can arrive more than once, so deduplicate on the envelope's `id`, which is stable across retries and equal to `X-Monaco-Delivery`. Order is not guaranteed. The envelope's `version` increases with every change to the entity, so ignore an envelope whose `version` is not greater than the last one you applied to that entity. Any 2xx acknowledges the delivery; anything else is retried about 10s, 20s and 40s later and then dead-lettered, except a 4xx other than 408 and 429, which is terminal and never retried. Redirects are not followed, and the request times out after 10s.

**Error codes**

| `error.code` | HTTP | Cause | What to do |
| --- | --- | --- | --- |
| `subscription_paused` | 409 | The subscription is paused, so the delivery would be dropped before it was sent. | Resume it with `PATCH /v1/webhooks/subscriptions/{id}`. |
| `not_found` | 422 | No subscription with this id exists in the calling org. | Check the id; a deleted subscription is never returned. |



## OpenAPI

````yaml https://api.monaco.com/openapi.json post /v1/webhooks/subscriptions/{subscription_id}/test
openapi: 3.1.0
info:
  title: Monaco Public API
  description: Public API for Monaco
  version: 1.0.0
servers:
  - url: https://api.monaco.com
security: []
paths:
  /v1/webhooks/subscriptions/{subscription_id}/test:
    post:
      tags:
        - Webhooks
      summary: Send a Test Delivery
      description: >-
        Queues one synthetic delivery so an endpoint and its signature check can
        be verified before a real trigger fires. It uses the same queue, signing
        and attempt logging as a real delivery; only the body is synthetic, and
        its `event` is the reserved key `webhook.test`.


        **Delivery semantics.** Delivery is at-least-once: the same envelope can
        arrive more than once, so deduplicate on the envelope's `id`, which is
        stable across retries and equal to `X-Monaco-Delivery`. Order is not
        guaranteed. The envelope's `version` increases with every change to the
        entity, so ignore an envelope whose `version` is not greater than the
        last one you applied to that entity. Any 2xx acknowledges the delivery;
        anything else is retried about 10s, 20s and 40s later and then
        dead-lettered, except a 4xx other than 408 and 429, which is terminal
        and never retried. Redirects are not followed, and the request times out
        after 10s.


        **Error codes**


        | `error.code` | HTTP | Cause | What to do |

        | --- | --- | --- | --- |

        | `subscription_paused` | 409 | The subscription is paused, so the
        delivery would be dropped before it was sent. | Resume it with `PATCH
        /v1/webhooks/subscriptions/{id}`. |

        | `not_found` | 422 | No subscription with this id exists in the calling
        org. | Check the id; a deleted subscription is never returned. |
      operationId: test_fire_webhook_subscription
      parameters:
        - name: subscription_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Subscription Id
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PublicItemResponse_WebhookTestFireResponse_
        4XX:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
components:
  schemas:
    PublicItemResponse_WebhookTestFireResponse_:
      properties:
        data:
          $ref: '#/components/schemas/WebhookTestFireResponse'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      type: object
      required:
        - data
      title: PublicItemResponse[WebhookTestFireResponse]
    PublicErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - error
      title: PublicErrorResponse
    WebhookTestFireResponse:
      properties:
        delivered_event_id:
          type: string
          title: Delivered Event Id
          description: The `id` the synthetic delivery will carry in its envelope
          examples:
            - test_0199c0ff-...
      type: object
      required:
        - delivered_event_id
      title: WebhookTestFireResponse
    ResponseMeta:
      properties:
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Server timestamp of the response
      type: object
      title: ResponseMeta
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
          description: Machine-readable error code
          examples:
            - not_found
        message:
          type: string
          title: Message
          description: Human-readable error message
          examples:
            - Resource not found
      type: object
      required:
        - code
        - message
      title: ErrorDetail

````

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