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

# Send a test webhook

> Sends a synthetic `alert.match.created` payload to every active webhook connection attached to this alert, so you can verify your endpoint end to end — receipt, signature, and parsing — without waiting for a real match. The payload is byte-for-byte shaped like a live delivery and carries this alert's real id, title, kind, and first watched entity, but its match content is illustrative sample data and the envelope is flagged `test: true` so your handler can skip real side effects. Nothing is persisted — a test never appears in the alert's delivery log. Returns one result per connection the test was POSTed to: whether the endpoint accepted the POST, its status code, and any error. Channels whose connection has been deleted are skipped and don't appear in the results. A down or non-2xx endpoint is reported as `delivered: false` rather than failing the request. Returns 422 when the alert has no active webhook connection — either none is configured, or every configured connection has been deleted.



## OpenAPI

````yaml /openapi.json post /v1/alerts/{id}/test-webhook
openapi: 3.1.0
info:
  description: Public API for Particle — news intelligence, financial data, and analysis.
  title: Particle API
  version: 0.1.0
servers:
  - url: https://api.particle.pro
security:
  - ApiKeyHeader: []
  - BearerAuth: []
paths:
  /v1/alerts/{id}/test-webhook:
    post:
      tags:
        - Alerts
        - tier:standard
      summary: Send a test webhook
      description: >-
        Sends a synthetic `alert.match.created` payload to every active webhook
        connection attached to this alert, so you can verify your endpoint end
        to end — receipt, signature, and parsing — without waiting for a real
        match. The payload is byte-for-byte shaped like a live delivery and
        carries this alert's real id, title, kind, and first watched entity, but
        its match content is illustrative sample data and the envelope is
        flagged `test: true` so your handler can skip real side effects. Nothing
        is persisted — a test never appears in the alert's delivery log. Returns
        one result per connection the test was POSTed to: whether the endpoint
        accepted the POST, its status code, and any error. Channels whose
        connection has been deleted are skipped and don't appear in the results.
        A down or non-2xx endpoint is reported as `delivered: false` rather than
        failing the request. Returns 422 when the alert has no active webhook
        connection — either none is configured, or every configured connection
        has been deleted.
      operationId: send-alert-test-webhook
      parameters:
        - description: Alert ID
          in: path
          name: id
          required: true
          schema:
            description: Alert ID
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertTestWebhookResult'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PlatformError'
          description: Error
      x-codeSamples:
        - label: cURL
          lang: curl
          source: |-
            curl -X POST \
              -H "X-API-Key: $PARTICLE_API_KEY" \
              "https://api.particle.pro/v1/alerts/{id}/test-webhook"
components:
  schemas:
    AlertTestWebhookResult:
      additionalProperties: false
      properties:
        deliveries:
          description: >-
            One entry per active webhook connection the test was POSTed to, in
            the order attempted. A channel whose connection has been deleted is
            skipped and does not appear here.
          items:
            $ref: '#/components/schemas/AlertTestWebhookDelivery'
          type:
            - array
            - 'null'
      required:
        - deliveries
      type: object
    PlatformError:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        error_code:
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        resolve:
          $ref: '#/components/schemas/ErrorResolve'
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    AlertTestWebhookDelivery:
      additionalProperties: false
      properties:
        delivered:
          description: True when the endpoint acknowledged with a 2xx status.
          type: boolean
        duration_ms:
          description: Round-trip time for the POST in milliseconds.
          format: int64
          type: integer
        error:
          description: >-
            Failure reason when delivered is false — the endpoint's non-2xx
            status or the transport error.
          type: string
        status_code:
          description: >-
            HTTP status the endpoint returned. Absent on a transport-level
            failure (timeout, connection refused, or a blocked non-public
            address).
          format: int64
          type: integer
        url:
          description: The destination the test payload was POSTed to.
          type: string
        webhook_connection_id:
          type: string
      required:
        - webhook_connection_id
        - url
        - delivered
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    ErrorResolve:
      additionalProperties: false
      properties:
        action:
          type: string
        endpoint:
          type: string
        message:
          type: string
        method:
          type: string
        url:
          type: string
      required:
        - message
      type: object
  securitySchemes:
    ApiKeyHeader:
      description: Pass your API key in the X-API-Key header (recommended).
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Pass your API key as a Bearer token in the Authorization header.
      scheme: bearer
      type: http

````